Skip to main content
PATCH
/
v2
/
customers
/
{id}
/
prescriptions
/
{prescriptionId}
Update customer prescription
curl --request PATCH \
  --url https://api.carecycle.ai/v2/customers/{id}/prescriptions/{prescriptionId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "dosage": "<string>",
  "frequency": "<string>",
  "route": "Oral",
  "status": "Active"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "dosage": "<string>",
  "frequency": "<string>",
  "route": "Oral",
  "status": "Active"
}

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)$
​
prescriptionId
string<uuid>
required

Prescription 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

PATCH /v2/customers/:id/prescriptions/:prescriptionId Request body

​
customerId
string<uuid>
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)$
​
name
string | null
Maximum string length: 255
​
dosage
string | null
Maximum string length: 100
​
frequency
string | null
Maximum string length: 100
​
route
enum<string> | null
Available options:
Oral,
Topical,
Injection,
Inhalation,
Sublingual,
Rectal,
Intravenous
​
status
enum<string> | null
Available options:
Active,
Expired,
Discontinued

Response

PATCH /v2/customers/:id/prescriptions/:prescriptionId 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)$
​
name
string | null
required
Maximum string length: 255
​
dosage
string | null
required
Maximum string length: 100
​
frequency
string | null
required
Maximum string length: 100
​
route
enum<string> | null
required
Available options:
Oral,
Topical,
Injection,
Inhalation,
Sublingual,
Rectal,
Intravenous
​
status
enum<string> | null
required
Available options:
Active,
Expired,
Discontinued