Skip to main content
DELETE
/
v1
/
organizations
/
{organization_id}
/
users
/
{user_id}
/
custom-drugs
/
{drug_id}
cURL
curl --request DELETE \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-secret: <x-organization-secret>'
{
  "success": true,
  "statusCode": 200,
  "message": "Success",
  "data": {},
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123",
  "pagination": {
    "count": 123,
    "hasNext": true,
    "limit": 123,
    "offset": 123,
    "lastKey": "<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.

Deletes a user-level custom drug.

​
Integration Notes

  1. Scope Requirement: Your API token must include the delete:custom_drug scope.
  2. Target: drug_id is the custom_drug_id returned by the list/create endpoints. Deletes the drug stored against USER#{user_id}.
  3. Idempotent: Deleting a drug that does not exist still returns 200.
  4. Scope of effect: Only user-level drugs are removed here. To clear the organization catalog use the bulk delete endpoint.

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)

Response

Custom drug deleted successfully

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
statusCode
integer
required

HTTP status code

Example:

200

​
message
string
required

Human-readable success message

Example:

"Success"

​
data
object
required

Response payload data

​
timestamp
string<date-time>
required

ISO 8601 timestamp of the response

Example:

"2024-01-15T10:30:00.000Z"

​
requestId
string
required

Unique identifier for request tracing

Example:

"req_1705312200000_abc123"

​
pagination
object

Pagination information for list operations