Skip to main content
POST
/
api
/
v1
/
reasons
Create a custom compounding reason
curl --request POST \
  --url https://api.byblend.com/api/v1/reasons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Physical location",
  "description": "Patient cannot access physical pharmacy due to natural disasters or similar event.",
  "parent_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
}
'
{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "name": "Adherence or Compliance",
  "description": "Issues related to patient adherence and medication compliance.",
  "is_global": true,
  "parent_id": null
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Short name, e.g. 'Swallowing Difficulty'

Example:

"Physical location"

​
description
string
required

Additional details of the compounding reason

Example:

"Patient cannot access physical pharmacy due to natural disasters or similar event."

​
parent_id
string

ID of the parent reason, if you wish to nest reasons under a global parent (e.g. 'Adherence or Compliance') or your own custom parent.

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

Response

201 - application/json

Compounding reason created successfully

​
id
string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

​
created_at
string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

​
updated_at
string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

​
name
string
Example:

"Adherence or Compliance"

​
description
string
Example:

"Issues related to patient adherence and medication compliance."

​
is_global
boolean

Whether the reason is a global reason (provided by Blend) or a customer-specific reason.

Example:

true

​
parent_id
string

UUID of the parent reason, or null if this is a top-level reason.

Example:

null