GuarantorV1

Update guarantor

Beta

PATCH

Updates a guarantor by its guarantor_id.

Path parameters

guarantor_idUUIDRequired

Request

This endpoint expects an object.

first_name

stringOptional

last_name

stringOptional

external_id

stringOptional

A unique identifier for the guarantor assigned by an external system.

date_of_birth

dateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-25.

address

objectOptional

phone_numbers

list of objectsOptional

phone_consent

booleanOptional

stringOptional

email_consent

booleanOptional

Response

This endpoint returns an object

email_consent

boolean

external_id

string

first_name

string

guarantor_id

UUID

last_name

string

phone_consent

boolean

phone_numbers

list of objects

address

objectOptional

date_of_birth

dateOptional

stringOptional

Built with

1	curl -X PATCH https://api.joincandidhealth.com/api/guarantors/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"email_consent": true,
3	"external_id": "string",
4	"first_name": "string",
5	"guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6	"last_name": "string",
7	"phone_consent": true,
8	"phone_numbers": [
9	{
10	"number": "string",
11	"type": "Home"
12	}
13	],
14	"address": {
15	"address1": "string",
16	"city": "string",
17	"state": "AA",
18	"zip_code": "string",
19	"address2": "string",
20	"zip_plus_four_code": "string"
21	},
22	"date_of_birth": "2023-01-01",
23	"email": "string"
24	}