Skip to main content
POST
/
v2
/
customers
/
{id}
/
providers
Create customer provider
curl --request POST \
  --url https://api.carecycle.ai/v2/customers/{id}/providers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "providerType": "Primary Care",
  "specialty": "<string>",
  "providerName": "<string>",
  "practiceName": "<string>",
  "npi": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "email": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postalCode": "<string>",
  "isPrimaryProvider": true,
  "isActive": true,
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerType": "Primary Care",
  "specialty": "<string>",
  "providerName": "<string>",
  "practiceName": "<string>",
  "npi": "<string>",
  "phone": "<string>",
  "fax": "<string>",
  "email": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postalCode": "<string>",
  "isPrimaryProvider": true,
  "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

Body

application/json

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

​
providerType
enum<string>
required
Available options:
Primary Care,
Specialist,
Hospital,
Pharmacy
​
specialty
string | null
Maximum string length: 255
​
providerName
string | null
Maximum string length: 255
​
practiceName
string | null
Maximum string length: 255
​
npi
string | null
Maximum string length: 50
​
phone
string | null
Maximum string length: 50
​
fax
string | null
Maximum string length: 50
​
email
string | null
Maximum string length: 255
​
address
string | null
Maximum string length: 255
​
address2
string | null
Maximum string length: 255
​
city
string | null
Maximum string length: 100
​
state
string | null
Maximum string length: 50
​
postalCode
string | null
Maximum string length: 20
​
isPrimaryProvider
boolean | null
​
isActive
boolean | null
​
notes
string | null
Maximum string length: 1000

Response

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

​
id
string<uuid>
required
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
customerId
string<uuid>
required
​
providerType
enum<string>
required
Available options:
Primary Care,
Specialist,
Hospital,
Pharmacy
​
specialty
string | null
required
Maximum string length: 255
​
providerName
string | null
required
Maximum string length: 255
​
practiceName
string | null
required
Maximum string length: 255
​
npi
string | null
required
Maximum string length: 50
​
phone
string | null
required
Maximum string length: 50
​
fax
string | null
required
Maximum string length: 50
​
email
string | null
required
Maximum string length: 255
​
address
string | null
required
Maximum string length: 255
​
address2
string | null
required
Maximum string length: 255
​
city
string | null
required
Maximum string length: 100
​
state
string | null
required
Maximum string length: 50
​
postalCode
string | null
required
Maximum string length: 20
​
isPrimaryProvider
boolean | null
required
​
isActive
boolean | null
required
​
notes
string | null
required
Maximum string length: 1000