Skip to main content
POST
/
v2
/
customers
/
{id}
/
dependents
Create customer dependent
curl --request POST \
  --url https://api.carecycle.ai/v2/customers/{id}/dependents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "dateOfBirth": "<string>",
  "gender": "Male",
  "annualIncome": -1,
  "relationshipType": "Spouse",
  "phone": "<string>",
  "email": "<string>",
  "ssn": "<string>",
  "isCovered": true,
  "coverageStartDate": "<string>",
  "coverageEndDate": "<string>",
  "isActive": true,
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "dateOfBirth": "<string>",
  "gender": "Male",
  "annualIncome": -1,
  "relationshipType": "Spouse",
  "phone": "<string>",
  "email": "<string>",
  "ssn": "<string>",
  "isCovered": true,
  "coverageStartDate": "<string>",
  "coverageEndDate": "<string>",
  "isActive": true,
  "notes": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
id
string<uuid>
required

Customer ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

POST /v2/customers/:id/dependents Request body

​
firstName
string | null
Maximum string length: 255
​
lastName
string | null
Maximum string length: 255
​
middleName
string | null
Maximum string length: 255
​
dateOfBirth
string | null
​
gender
enum<string> | null
Available options:
Male,
Female,
Non-Binary,
Other,
Prefer Not to Say
​
annualIncome
integer | null
Required range: -2147483648 <= x <= 2147483647
​
relationshipType
enum<string> | null
Available options:
Spouse,
Child,
Parent,
Sibling,
Other
​
phone
string | null
Maximum string length: 50
​
email
string | null
Maximum string length: 255
​
ssn
string | null
Maximum string length: 11
​
isCovered
boolean | null
​
coverageStartDate
string | null
​
coverageEndDate
string | null
​
isActive
boolean | null
​
notes
string | null
Maximum string length: 1000

Response

POST /v2/customers/:id/dependents Positive response

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
customerId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
firstName
string | null
required
Maximum string length: 255
​
lastName
string | null
required
Maximum string length: 255
​
middleName
string | null
required
Maximum string length: 255
​
dateOfBirth
string | null
required
​
gender
enum<string> | null
required
Available options:
Male,
Female,
Non-Binary,
Other,
Prefer Not to Say
​
annualIncome
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
relationshipType
enum<string> | null
required
Available options:
Spouse,
Child,
Parent,
Sibling,
Other
​
phone
string | null
required
Maximum string length: 50
​
email
string | null
required
Maximum string length: 255
​
ssn
string | null
required
Maximum string length: 11
​
isCovered
boolean | null
required
​
coverageStartDate
string | null
required
​
coverageEndDate
string | null
required
​
isActive
boolean | null
required
​
notes
string | null
required
Maximum string length: 1000