Skip to main content
PUT
/
v1
/
organizations
/
{organization_id}
/
users
/
{user_id}
/
custom-drugs
/
{drug_id}
cURL
curl --request PUT \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-organization-secret: <x-organization-secret>' \
  --data '
{
  "item_generic_name": "<string>",
  "item_trade_name": "<string>",
  "brand_name": "<string>",
  "item_strength": "<string>",
  "item_form": "<string>",
  "route_of_administration": "<string>",
  "quantity": "<string>",
  "max_repeats": "<string>",
  "poison_class": "<string>",
  "custom_product_id": "<string>",
  "description": "<string>",
  "patient_instructions": "<string>",
  "doctor_instructions": "<string>"
}
'
{
  "success": true,
  "statusCode": 123,
  "message": "<string>",
  "code": "SUCCESS",
  "data": {
    "custom_drug_id": "<string>",
    "item_generic_name": "<string>",
    "item_trade_name": "<string>",
    "brand_name": "<string>",
    "item_strength": "<string>",
    "item_form": "<string>",
    "route_of_administration": "<string>",
    "quantity": "<string>",
    "max_repeats": "<string>",
    "poison_class": "<string>",
    "custom_product_id": "<string>",
    "description": "<string>",
    "patient_instructions": "<string>",
    "doctor_instructions": "<string>"
  },
  "timestamp": "<string>",
  "requestId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.parchmenthealth.io/llms.txt

Use this file to discover all available pages before exploring further.

Updates a user-level custom drug. Send only the fields you want to change.

​
Integration Notes

  1. Scope Requirement: Your API token must include the update:custom_drug scope.
  2. Target: drug_id is the custom_drug_id returned by the list/create endpoints. The drug must already exist for this user — otherwise 404 is returned.
  3. Partial update: Only the provided fields are changed; omitted fields are left untouched.
  4. Response: Returns the updated drug.

​
Example Request

{
  "quantity": "60",
  "max_repeats": "3",
  "patient_instructions": "Take one capsule three times daily"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-organization-secret
string
required

Organization secret for authentication - provided by Parchment

Path Parameters

​
organization_id
string<uuid>
required

Organization ID

​
user_id
string
required

User ID

​
drug_id
string
required

Custom drug ID (custom_drug_id from the list endpoint)

Body

application/json

Partial custom drug fields to update

Partial custom drug fields to update. Send only the fields to change.

​
item_generic_name
string
Maximum string length: 280
​
item_trade_name
string
Maximum string length: 280
​
brand_name
string
Maximum string length: 100
​
item_strength
string
Maximum string length: 100
​
item_form
string
Maximum string length: 50
​
route_of_administration
string
Maximum string length: 50
​
quantity
string
​
max_repeats
string
​
poison_class
string
Maximum string length: 2
​
custom_product_id
string
Maximum string length: 50
​
description
string
Maximum string length: 280
​
patient_instructions
string
Maximum string length: 250
​
doctor_instructions
string
Maximum string length: 50

Response

Custom drug updated successfully

​
success
boolean
​
statusCode
integer
​
message
string
​
code
string
Example:

"SUCCESS"

​
data
object

A custom drug as exposed to partners. custom_drug_id is the unique identifier used to prefill the prescription form.

​
timestamp
string
​
requestId
string