Skip to main content
DELETE
/
v1
/
organizations
/
{organization_id}
/
custom-drugs
cURL
curl --request DELETE \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/custom-drugs \
  --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.

This permanently deletes every organization-level custom drug for the organization. It is irreversible.

​
Integration Notes

  1. Scope Requirement: Your API token must include the delete:custom_drug scope.
  2. Confirmation required: You must pass ?confirm=true. Without it the request returns 400 and nothing is deleted.
  3. Scope of effect: Removes all organization-level drugs (ORGANIZATION#{organization_id}). User-level drugs are not affected.

​
Example Request

DELETE /v1/organizations/{organization_id}/custom-drugs?confirm=true

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

Query Parameters

​
confirm
enum<string>
required

Must be true to confirm the destructive wipe

Available options:
true

Response

All organization custom drugs deleted

​
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