GuarantorV1

Update guarantor

Beta
PATCH
https://api.joincandidhealth.com/api/guarantors/v1/:guarantor_id

Updates a guarantor by its guarantor_id.

Path parameters

guarantor_id
UUID

Request

This endpoint expects an object.
first_name
optional string
last_name
optional string
external_id
optional string
A unique identifier for the guarantor assigned by an external system.
date_of_birth
optional date
Date formatted as YYYY-MM-DD; eg: 2019-08-25.
address
optional object
phone_numbers
optional list of objects
phone_consent
optional boolean
email
optional string
email_consent
optional boolean

Response

This endpoint return 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
optional object
date_of_birth
optional date
email
optional string
PATCH
/api/guarantors/v1/:guarantor_id
curl -X PATCH https://api.joincandidhealth.com/api/guarantors/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"email_consent": true,
"external_id": "string",
"first_name": "string",
"guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"last_name": "string",
"phone_consent": true,
"phone_numbers": [
{
"number": "string",
"type": "Home"
}
],
"address": {
"address1": "string",
"city": "string",
"state": "AA",
"zip_code": "string",
"address2": "string",
"zip_plus_four_code": "string"
},
"date_of_birth": "2023-01-01",
"email": "string"
}