Update guarantor

Beta

PATCH

/api/guarantors/v1/:guarantor_id

Updates a guarantor by its guarantor_id.

guarantor_idUUIDRequired

This endpoint expects an object.

first_namestringOptional

last_namestringOptional

external_idstringOptional

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

date_of_birthdateOptional

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

addressobjectOptional

phone_numberslist of objectsOptional

phone_consentbooleanOptional

emailstringOptional

email_consentbooleanOptional

This endpoint returns an object.

addressobject

email_consentboolean

external_idstring

first_namestring

guarantor_idUUID

last_namestring

phone_consentboolean

phone_numberslist of objects

date_of_birthdateOptional

emailstringOptional

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