Create a new prescriber

curl --request POST \
  --url https://api.byblend.com/api/v1/prescribers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Willard",
  "last_name": "Donnelly",
  "phone": "6417383445",
  "npi": "1234567890",
  "middle_name": "Moises",
  "email": "[email protected]",
  "date_of_birth": "1990-01-01",
  "gender": "Male",
  "dea": "F91234563",
  "spi": "1234567890ABCDEF",
  "driver_license_number": "B49188319",
  "driver_license_state": "CA",
  "is_active": true,
  "credential_npi": "M.D./Ph.D",
  "addresses": [
    {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "type": "practice",
      "address_2": "Apt 227",
      "country": "US"
    }
  ],
  "credentials": [
    {
      "credential_code": "MD"
    }
  ],
  "restrictions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
    }
  ],
  "qualifications": [
    {
      "state": "CA",
      "license_number": "1234567890",
      "description": "Nurse Practitioner, Family",
      "expiration_date": "2025-03-15",
      "is_active": true
    }
  ]
}
'

{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "first_name": "Willard",
  "middle_name": "Moises",
  "last_name": "Donnelly",
  "email": "[email protected]",
  "phone": "6417383445",
  "date_of_birth": "1990-01-01",
  "gender": "Male",
  "npi": "1234567890",
  "dea": "F91234563",
  "spi": "1234567890ABCDEF",
  "driver_license_number": "B49188319",
  "driver_license_state": "CA",
  "is_active": true,
  "credential_npi": "M.D./Ph.D",
  "addresses": [
    {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "address_2": "Apt 227",
      "country": "US",
      "type": "practice"
    }
  ],
  "qualifications": [
    {
      "state": "CA",
      "license_number": "1234567890",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "description": "Nurse Practitioner, Family",
      "expiration_date": "2025-03-15",
      "is_active": true
    }
  ],
  "credentials": [
    {
      "credential_code": "MD",
      "credential_name": "Doctor of Medicine"
    }
  ],
  "restrictions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Mupirocin",
      "sku": "1234567890"
    }
  ]
}

POST

api

prescribers

Create a new prescriber

curl --request POST \
  --url https://api.byblend.com/api/v1/prescribers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Willard",
  "last_name": "Donnelly",
  "phone": "6417383445",
  "npi": "1234567890",
  "middle_name": "Moises",
  "email": "[email protected]",
  "date_of_birth": "1990-01-01",
  "gender": "Male",
  "dea": "F91234563",
  "spi": "1234567890ABCDEF",
  "driver_license_number": "B49188319",
  "driver_license_state": "CA",
  "is_active": true,
  "credential_npi": "M.D./Ph.D",
  "addresses": [
    {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "type": "practice",
      "address_2": "Apt 227",
      "country": "US"
    }
  ],
  "credentials": [
    {
      "credential_code": "MD"
    }
  ],
  "restrictions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
    }
  ],
  "qualifications": [
    {
      "state": "CA",
      "license_number": "1234567890",
      "description": "Nurse Practitioner, Family",
      "expiration_date": "2025-03-15",
      "is_active": true
    }
  ]
}
'

{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "first_name": "Willard",
  "middle_name": "Moises",
  "last_name": "Donnelly",
  "email": "[email protected]",
  "phone": "6417383445",
  "date_of_birth": "1990-01-01",
  "gender": "Male",
  "npi": "1234567890",
  "dea": "F91234563",
  "spi": "1234567890ABCDEF",
  "driver_license_number": "B49188319",
  "driver_license_state": "CA",
  "is_active": true,
  "credential_npi": "M.D./Ph.D",
  "addresses": [
    {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "address_2": "Apt 227",
      "country": "US",
      "type": "practice"
    }
  ],
  "qualifications": [
    {
      "state": "CA",
      "license_number": "1234567890",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "description": "Nurse Practitioner, Family",
      "expiration_date": "2025-03-15",
      "is_active": true
    }
  ],
  "credentials": [
    {
      "credential_code": "MD",
      "credential_name": "Doctor of Medicine"
    }
  ],
  "restrictions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Mupirocin",
      "sku": "1234567890"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

first_name

string

required

Example:

"Willard"

last_name

string

required

Example:

"Donnelly"

phone

string

required

10-digit phone number without formatting, e.g. 6417383445

Example:

"6417383445"

npi

string

required

National Provider Identifier

Example:

"1234567890"

middle_name

string

Example:

"Moises"

string

Example:

"[email protected]"

date_of_birth

string<date>

Example:

"1990-01-01"

gender

string

Gender of the prescriber

Example:

"Male"

dea

string

DEA Registration Number

Example:

"F91234563"

spi

string

Surescripts Provider ID

Example:

"1234567890ABCDEF"

driver_license_number

string

Driver's license number

Example:

"B49188319"

driver_license_state

string

Two-letter state abbreviation

Example:

"CA"

is_active

boolean

Whether the prescriber is currently active

Example:

true

credential_npi

string

Direct credential text as provided by the NPI registry

Example:

"M.D./Ph.D"

addresses

object[]

Show child attributes

addresses.address_1

string

required

Example:

"140 Lindgren Streets"

addresses.city

string

required

Example:

"North Consueloburgh"

addresses.state

string

required

Two-letter state abbreviation

Example:

"CA"

addresses.zip_code

string

required

5-digit ZIP code or 9-digit ZIP+4 code, e.g. 02108 or 02108-1234.

Example:

"02108"

addresses.type

string

required

Type of address, either 'practice' or 'working'

Example:

"practice"

addresses.address_2

string

Example:

"Apt 227"

addresses.country

string

Two-letter country code, defaults to US

Example:

"US"

credentials

object[]

Array of credentials, with each credential_code representing the prescriber's credentials

Show child attributes

credentials.credential_code

string

Example:

"MD"

restrictions

object[]

Array of prescription product IDs that are restricted from being prescribed by the prescriber

Show child attributes

restrictions.id

string<uuid>

ID of the prescription product that is restricted

Example:

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

qualifications

object[]

Show child attributes

qualifications.state

string

required

Example:

"CA"

qualifications.license_number

string

required

License number for the prescriber in this state. Note that when a state qualification is updated with a new license number, the old qualification will be automatically deactivated.

Example:

"1234567890"

qualifications.description

string

Description of the license qualification

Example:

"Nurse Practitioner, Family"

qualifications.expiration_date

string<date>

Example:

"2025-03-15"

qualifications.is_active

boolean

Example:

true

Response

201 - application/json

Prescriber created successfully

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"

first_name

string

Example:

"Willard"

middle_name

string

Example:

"Moises"

last_name

string

Example:

"Donnelly"

string

Example:

"[email protected]"

phone

string

10-digit phone number without formatting, e.g. 6417383445

Example:

"6417383445"

date_of_birth

string<date>

Example:

"1990-01-01"

gender

string

Gender of the prescriber

Example:

"Male"

npi

string

National Provider Identifier

Example:

"1234567890"

dea

string

DEA Registration Number

Example:

"F91234563"

spi

string

Surescripts Provider ID

Example:

"1234567890ABCDEF"

driver_license_number

string

Driver's license number

Example:

"B49188319"

driver_license_state

string

Two-letter state abbreviation

Example:

"CA"

is_active

boolean

Whether the prescriber is currently active

Example:

true

credential_npi

string

Direct credential text as provided by the NPI registry

Example:

"M.D./Ph.D"

addresses

object[]

Show child attributes

addresses.address_1

string

required

Example:

"140 Lindgren Streets"

addresses.city

string

required

Example:

"North Consueloburgh"

addresses.state

string

required

Two-letter state abbreviation

Example:

"CA"

addresses.zip_code

string

required

5-digit ZIP code or 9-digit ZIP+4 code, e.g. 02108 or 02108-1234.

Example:

"02108"

addresses.id

string<uuid>

Unique identifier

Example:

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

addresses.created_at

string<date-time>

Date and time of creation

Example:

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

addresses.updated_at

string<date-time>

Date and time of last update

Example:

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

addresses.address_2

string

Example:

"Apt 227"

addresses.country

string

Two-letter country code, defaults to US

Example:

"US"

addresses.type

string

Type of address, either 'practice' or 'working'

Example:

"practice"

qualifications

object[]

Show child attributes

qualifications.state

string

required

Example:

"CA"

qualifications.license_number

string

required

License number for the prescriber in this state. Note that when a state qualification is updated with a new license number, the old qualification will be automatically deactivated.

Example:

"1234567890"

qualifications.id

string<uuid>

Unique identifier

Example:

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

qualifications.created_at

string<date-time>

Date and time of creation

Example:

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

qualifications.updated_at

string<date-time>

Date and time of last update

Example:

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

qualifications.description

string

Description of the license qualification

Example:

"Nurse Practitioner, Family"

qualifications.expiration_date

string<date>

Example:

"2025-03-15"

qualifications.is_active

boolean

Example:

true

credentials

object[]

Show child attributes

credentials.credential_code

string

Example:

"MD"

credentials.credential_name

string

Example:

"Doctor of Medicine"

restrictions

object[]

Show child attributes

restrictions.id

string<uuid>

Unique identifier

Example:

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

restrictions.name

string

Example:

"Mupirocin"

restrictions.sku

string

Example:

"1234567890"

Get all available prescribers Get a prescriber's details

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Create a new prescriber

Authorizations

Body

Response