CAcarecycle
Customers.Providers

Update customer provider

Change a doctor or other healthcare provider on a customer's record.

patch/v2/customers/{id}/providers/{providerId}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/customers/{id}/providers/{providerId}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Customer ID

providerIdstring uuid required

Provider ID

Request body

customerIdstring uuid
providerType'Primary Care' | 'Specialist' | 'Hospital' | 'Pharmacy'
specialtystring nullable
providerNamestring nullable
practiceNamestring nullable
npistring nullable
phonestring nullable
faxstring nullable
emailstring nullable
addressstring nullable
address2string nullable
citystring nullable
statestring nullable
postalCodestring nullable
isPrimaryProviderboolean nullable
isActiveboolean nullable
notesstring nullable
connectureProviderIdstring nullable
connectureAddressIdstring nullable
isIndividualboolean nullable

Response

PATCH /v2/customers/:id/providers/:providerId Positive response

idstring uuid required
createdAtstring date-time nullable required

Provider creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Provider last update time. ISO 8601 timestamp

customerIdstring uuid required
providerType'Primary Care' | 'Specialist' | 'Hospital' | 'Pharmacy' required
specialtystring nullable required
providerNamestring nullable required
practiceNamestring nullable required
npistring nullable required
phonestring nullable required
faxstring nullable required
emailstring nullable required
addressstring nullable required
address2string nullable required
citystring nullable required
statestring nullable required
postalCodestring nullable required
isPrimaryProviderboolean nullable required
isActiveboolean nullable required
notesstring nullable required
connectureProviderIdstring nullable required
connectureAddressIdstring nullable required
isIndividualboolean nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.