Update custom drug - Parchment Health developer docs

PUT

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>"
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}"

payload = {
    "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>"
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}"

	payload := strings.NewReader("{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

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

Integration Notes

Scope Requirement: Your API token must include the update:custom_drug scope.
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.
Partial update: Only the provided fields are changed; omitted fields are left untouched.
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.

Show child attributes

timestamp

string

requestId

string

Delete custom drugDeletes a user-level custom drug.

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>"
}
'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}"

payload = {
    "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>"
}
headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}"

	payload := strings.NewReader("{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/custom-drugs/{drug_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_generic_name\": \"<string>\",\n  \"item_trade_name\": \"<string>\",\n  \"brand_name\": \"<string>\",\n  \"item_strength\": \"<string>\",\n  \"item_form\": \"<string>\",\n  \"route_of_administration\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"max_repeats\": \"<string>\",\n  \"poison_class\": \"<string>\",\n  \"custom_product_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"patient_instructions\": \"<string>\",\n  \"doctor_instructions\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": {
    "type": "https://parchment.health/errors/validation-error",
    "title": "Validation failed",
    "detail": "There were some problems with your input.",
    "instance": "/patients/123",
    "validation": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_def456",
  "code": "RESOURCE_NOT_FOUND",
  "meta": {
    "apiVersion": "1.0"
  }
}

​Integration Notes

​Example Request

Authorizations

Headers

Path Parameters

Body

Response

Integration Notes

Example Request