Skip to main content
API docs by Redocly

API Reference (1.0.0)

Download OpenAPI specification:Download

With Healee API 1.0, you can create applications that interact with key components of the Healee platform.

Create a new patient account

This route should be used during the process of creating a new patient account in third party applications integrating with Healee. Requiring a password would make sure that only the patients themselves can be authenticated in Healee.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "user_access_token": {
    }
}

Find patients by different criteria

Use this route to find patients by different criteria. Operators such as <=, >=, <, >, !, != can be used in the query parameters.

query Parameters
limit
integer

The number of patients to return (default and max value allowed - 100). Used for pagination.

offset
integer

The number of patients to skip (default value - 0). Used for pagination.

id
string

Patient's unique identifier.

email
string

Patient's email.

first_name
string

Patient's first name.

last_name
string

Patient's last name.

birth_year
integer

Patient's unique identifier.

phone_number
string

Patient's phone number.

phone_code
string

Patient's international phone code.

gender
string

Patient's gender (male | female | unknown).

date_created
string

Patient's account creation date (in ISO date time format).

date_created
string

Patient's account creation date (in ISO date time format).

date_last_access
string

Patient's last access date (in ISO date time format).

timezone
string

Patient's timezone.

state
string

Patient's state.

city
string

Patient's city.

state
string

Patient's state.

address
string

Patient's address.

address2
string

Patient's address details.

zip_code
string

Patient's address zip code.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

Find patient payments by different criteria

Use this route to find patient payments by different criteria. Operators such as <=, >=, <, >, !, != can be used in the query parameters when applicable.

query Parameters
limit
integer

The number of payments to return (default and max value allowed - 100). Used for pagination.

offset
integer

The number of payments to skip (default value - 0). Used for pagination.

id
string

The unique identifier of the payment.

patient_id
string

The unique identifier of the patient associated with the payment.

amount
number

The amount of money spent for the payment.

currency
string

The currency of the payment.

original_amount
number

The original amount of money spent for the payment.

original_currency
string

The original currency of the payment.

email
string

The email of the patient associated with the payment.

processing
boolean

The processing status of the payment.

handled
boolean

The handled status of the payment.

date_handled
string

The date when the payment was handled (in ISO date time format).

paid
boolean

The paid status of the payment.

payment_purpose
string

The purpose of the payment.

payment_provider
string

The payment provider used for the payment.

provider_name
string

The name of the provider associated with the payment.

date
string

The date of the payment (in ISO date time format).

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

Find patient subscriptions by different criteria

Use this route to find patient subscriptions by different criteria. Operators such as <=, >=, <, >, !, != can be used in the query parameters when applicable.

query Parameters
limit
integer

The number of subscriptions to return (default and max value allowed - 100). Used for pagination.

offset
integer

The number of subscriptions to skip (default value - 0). Used for pagination.

id
string

The unique identifier of the subscription.

patient_id
string

The unique identifier of the patient associated with the subscription.

customer_id
string

The unique identifier of the payment provider customer associated with the subscription.

product_id
string

The unique identifier of the payment provider product associated with the subscription.

period_end
string

The end date of the subscription period (in ISO date time format).

start_date
string

The start date of the subscription (in ISO date time format).

cancel_date
string

The date when the subscription was canceled (in ISO date time format).

interval
string

The interval of the subscription (day, month, year).

interval_count
integer

The number of intervals for the subscription.

amount
number

The money spent for the subscription.

currency
string

The currency of the payment made for the subscription.

status
string

The status of the subscription.

product_name
string

The name of the payment provider product associated with the subscription.

product_description
string

The description of the payment provider product associated with the subscription.

product_active
boolean

The active status of the payment provider product associated with the subscription.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

Create a new provider account

This route should be used during the process of creating a new provider account in third party applications integrating with Healee MD. Requiring a password would make sure that only the providers themselves can be authenticated in Healee MD.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "user_access_token": {
    }
}

Create a temporary access token for a user's account

Use this route during the login process for your users to create an access token for a user's account.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
grant_type
string
Value: "password"
user_type
string
Default: "patient"
Enum: "patient" "provider"
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "grant_type": "password",
  • "user_type": "patient",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_on": "string",
  • "token_type": "Bearer"
}

Upload a file associated with a patient account

Use this route to upload a file and associate it with a patient account.

header Parameters
Authorization
required
string <Bearer [Patient OAuth token]>

The API authorization header.

Request Body schema: multipart/form-data
file
object <binary>

Responses

Response samples

Content type
application/json
{
  • "_id": "string"
}

Create / Update / Delete FHIR resources

FHIR endpoint for create / update / delete operations on FHIR resources. The currently supported resource types are Patient and Practitioner (https://build.fhir.org/administration-module.html). Could be used by FHIR Subscriptions for achieving 2-way sync between FHIR enabled platforms and Healee.

header Parameters
Authorization
required
string <Bearer [Patient OAuth token]>

The API authorization header.

X-Healee-Connector-Id
string

The unique identifier of the FHIR connector (specified in Healee's configuration).

Request Body schema: application/fhir+json
object

Responses

Request samples

Content type
application/fhir+json
{ }

Response samples

Content type
application/json
{ }

Create a new appointment

Use this route to create a new appointment.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

X-connect
string

Integration platform name.

Request Body schema: application/json
date
required
string <YYYY-MM-DD>

The date of the appointment.

time
required
string <HH:mm>

The time of the appointment.

calendar_id
integer

The ID of the calendar. Required unless practice_id is provided.

practice_id
integer

The ID of the practice. Required unless calendar_id is provided.

remote_id
string

The ID of appointment in the external (integrating) system (50 characters limit).

insurer_id
integer

The ID of the insurer.

name
required
string

The name of the patient (50 characters limit).

age
integer

The age of the patient.

phone_code
string

The phone country code of the patient's phone number (digits only, i.e. 44).

phone
string

The patient's phone number (excl. country code).

email
string

The patient's email.

video
boolean
Default: false

A flag indicating whether this is a video consultation.

double
boolean
Default: false

A flag indicating whether this is a double booking for this slot.

payment_method_id
integer

The ID of the payment method.

reason_id
integer

The ID of the reason for visit.

new
boolean
Default: true

A flag indicating whether this is a new patient.

notes
string

Additional info for the appointment (300 characters limit).

insurer_fields
object

Custom insurer fields.

insurer_name
string

The name of the insurer.

Responses

Request samples

Content type
application/json
{
  • "calendar_id": 12,
  • "date": "2023-12-20",
  • "time": "08:30",
  • "name": "John Smith",
  • "email": "john@smith.com",
  • "reason_id": 10
}

Response samples

Content type
application/json
{
  • "result": true,
  • "id": "string",
  • "message": "string"
}

Update an existing appointment

Use this route to update an existing appointment.

path Parameters
id
integer

The ID of the appointment. Could be also provided in the request body, or could be omitted if the remote_id parameter is provided.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

X-connect
string

Integration platform name.

Request Body schema: application/json
remote_id
string

The ID of appointment in the external (integrating) system. Required if the id url parameter is not provided.

calendar_id
integer

The ID of the calendar. Required if remote_id is provided and practice_id is not provided.

practice_id
integer

The ID of the practice. Required if remote_id is provided and calendar_id is not provided.

name
string

The name of the patient (50 characters limit).

age
integer

The age of the patient.

phone_code
string

The phone country code of the patient's phone number (digits only, i.e. 44).

phone
string

The patient's phone number (excl. country code).

email
string

The patient's email.

video
boolean
Default: false

A flag indicating whether this is a video consultation.

double
boolean
Default: false

A flag indicating whether this is a double booking for this slot.

payment_method_id
integer

The ID of the payment method.

reason_id
integer

The ID of the reason for visit.

new
boolean
Default: true

A flag indicating whether this is a new patient.

notes
string

Additional info for the appointment (300 characters limit).

insurer_fields
object

Custom insurer fields.

insurer_name
string

The name of the insurer.

Responses

Request samples

Content type
application/json
{
  • "remote_id": "string",
  • "calendar_id": 0,
  • "practice_id": 0,
  • "name": "string",
  • "age": 0,
  • "phone_code": "string",
  • "phone": "string",
  • "email": "string",
  • "video": false,
  • "double": false,
  • "payment_method_id": 0,
  • "reason_id": 0,
  • "new": true,
  • "notes": "string",
  • "insurer_fields": { },
  • "insurer_name": "string"
}

Response samples

Content type
application/json
{
  • "result": true,
  • "id": "string",
  • "message": "string"
}

Delete an existing appointment

Use this route to delete an existing appointment.

path Parameters
id
integer

The ID of the appointment. Could be also provided in the request body, or could be omitted if the remote_id parameter is provided.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

X-connect
string

Integration platform name.

Request Body schema: application/json
remote_id
string

The ID of appointment in the external (integrating) system. Required if the id url parameter is not provided.

calendar_id
integer

The ID of the calendar. Required if remote_id is provided and practice_id is not provided.

practice_id
integer

The ID of the practice. Required if remote_id is provided and calendar_id is not provided.

reason_for_cancel
string

The reason for cancellation to be sent in a notification.

Responses

Request samples

Content type
application/json
{
  • "remote_id": "string",
  • "calendar_id": 0,
  • "practice_id": 0,
  • "reason_for_cancel": "string"
}

Response samples

Content type
application/json
{
  • "result": true,
  • "id": "string",
  • "message": "string"
}

Reschedule an existing appointment

Use this route to reschedule an existing appointment.

path Parameters
id
integer

The ID of the appointment. Could be also provided in the request body, or could be omitted if the remote_id parameter is provided.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

X-connect
string

Integration platform name.

Request Body schema: application/json
remote_id
string

The ID of appointment in the external (integrating) system. Required if the id url parameter is not provided.

calendar_id
integer

The ID of the calendar. Required if remote_id is provided and practice_id is not provided.

practice_id
integer

The ID of the practice. Required if remote_id is provided and calendar_id is not provided.

reschedule_calendar_id
integer

The ID of the calendar where appointment will be rescheduled. Required if reschedule_practice_id is not provided.

reschedule_practice_id
integer

The ID of the practice where appointment will be rescheduled. Required if reschedule_calendar_id is not provided.

date
required
string <YYYY-MM-DD>

The date of the rescheduled appointment.

time
required
string <HH:mm>

The time of the rescheduled appointment.

slot
integer

The slot ID in the calendar where appointment will be rescheduled.

Responses

Request samples

Content type
application/json
{
  • "remote_id": "string",
  • "calendar_id": 0,
  • "practice_id": 0,
  • "reschedule_calendar_id": 0,
  • "reschedule_practice_id": 0,
  • "date": "string",
  • "time": "string",
  • "slot": 0
}

Response samples

Content type
application/json
{
  • "result": true,
  • "id": "string",
  • "message": "string"
}

Get a list of existing doctors

Use this route to get a list of existing doctors.

query Parameters
name
string

Doctor's name, full or partial.

page
integer

The page number.

clinic_id
integer
city_id
integer
region_id
integer
specialty_id
integer
reason_id
integer
kids
boolean
price
boolean
state_insurance
boolean
insurance_id
integer
online
boolean
video
boolean
home_visits
boolean
sex
string
earliest
integer
sort
string
lat
integer
lat_min
integer
lat_max
integer
lng
integer
lng_min
integer
lng_max
integer
location
string
licensed_in
integer
symptom_id
integer
tags
Array of integers
hidden
boolean
header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

X-connect
string

Integration platform name.

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

Get all existing forms

Use this route to get the currently configured eligibility forms.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new form

Use this route to create a new form.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
id
string

The unique ID of the form.

form_id
string

The ID of the form. It's not unique as forms of different type but with the same ID can overwrite each other.

type
required
string
Enum: "beforeLogin" "afterEssentials" "search"

Type refers to the point of the registration process at which the form should be filled by the patient.

skip_token
string

A token that can be used to skip the form. It's placed in a link that is sent to the patient.

overwrite
boolean

If true, the form will overwrite any existing form with the same ID. If false, the form will be added to the existing patient's forms.

required
boolean

If true, the form will be required to be filled by the patient.

default
boolean

If true, the form will be the default form for the given type.

required
object (FormJson)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "type": "beforeLogin",
  • "skip_token": "string",
  • "overwrite": true,
  • "required": true,
  • "default": true,
  • "form": {
    }
}

Response samples

Content type
application/json
{
  • "type": "beforeLogin",
  • "form": {
    }
}

Get an existing form

Use this route to get a specific form by its unique ID.

path Parameters
id
required
string

The ID of the form to retrieve.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "type": "beforeLogin",
  • "skip_token": "string",
  • "overwrite": true,
  • "required": true,
  • "default": true,
  • "form": {
    }
}

Update an existing form

Use this route to update an existing form. You can pass only the properties that you want to update.

path Parameters
id
required
string

The ID of the form to update.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
id
string

The unique ID of the form.

form_id
string

The ID of the form. It's not unique as forms of different type but with the same ID can overwrite each other.

type
required
string
Enum: "beforeLogin" "afterEssentials" "search"

Type refers to the point of the registration process at which the form should be filled by the patient.

skip_token
string

A token that can be used to skip the form. It's placed in a link that is sent to the patient.

overwrite
boolean

If true, the form will overwrite any existing form with the same ID. If false, the form will be added to the existing patient's forms.

required
boolean

If true, the form will be required to be filled by the patient.

default
boolean

If true, the form will be the default form for the given type.

required
object (FormJson)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "type": "beforeLogin",
  • "skip_token": "string",
  • "overwrite": true,
  • "required": true,
  • "default": true,
  • "form": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "form_id": "string",
  • "type": "beforeLogin",
  • "skip_token": "string",
  • "overwrite": true,
  • "required": true,
  • "default": true,
  • "form": {
    }
}

Delete an existing form

Use this route to delete an existing form.

path Parameters
id
required
string

The ID of the form to delete.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
"string"

Get all existing medical forms

Use this route to get the currently configured medical forms.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new medical form

Use this route to create a new medical form.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
id
string

The unique ID of the medical form.

doctor_id
string

The ID of the provider with whom the form is associated if it's not a shared form.

type
required
string
Enum: "noteForm" "patientForm"

The type of the medical form.

name
string

The name of the medical form.

auto_appointment
boolean

If true, the medical form will be sent automatically to the patient when an appointment is scheduled for the first time.

auto_when_connected
boolean

If true, the medical form will be sent automatically to the patient when the provider connects to the patient.

auto_after_each
boolean

If true, the medical form will be sent automatically to the patient after each appointment.

required
object (FormJson)
options
object

The options of the medical form.

shared
boolean

If true, the medical form is shared among all providers.

specialties
Array of arrays

The IDs of the provider specialties to which the form is associated (if it's a shared form).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "doctor_id": "string",
  • "type": "noteForm",
  • "name": "string",
  • "auto_appointment": true,
  • "auto_when_connected": true,
  • "auto_after_each": true,
  • "form": {
    },
  • "options": { },
  • "shared": true,
  • "specialties": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "doctor_id": "string",
  • "type": "noteForm",
  • "name": "string",
  • "auto_appointment": true,
  • "auto_when_connected": true,
  • "auto_after_each": true,
  • "form": {
    },
  • "options": { },
  • "shared": true,
  • "specialties": [ ]
}

Get an existing medical form

Use this route to get a specific medical form by its unique ID.

path Parameters
id
required
string

The ID of the medical form to retrieve.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "doctor_id": "string",
  • "type": "noteForm",
  • "name": "string",
  • "auto_appointment": true,
  • "auto_when_connected": true,
  • "auto_after_each": true,
  • "form": {
    },
  • "options": { },
  • "shared": true,
  • "specialties": [ ]
}

Update an existing medical form

Use this route to update an existing medical form. You can pass only the properties that you want to update.

path Parameters
id
required
string

The ID of the medical form to update.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
id
string

The unique ID of the medical form.

doctor_id
string

The ID of the provider with whom the form is associated if it's not a shared form.

type
required
string
Enum: "noteForm" "patientForm"

The type of the medical form.

name
string

The name of the medical form.

auto_appointment
boolean

If true, the medical form will be sent automatically to the patient when an appointment is scheduled for the first time.

auto_when_connected
boolean

If true, the medical form will be sent automatically to the patient when the provider connects to the patient.

auto_after_each
boolean

If true, the medical form will be sent automatically to the patient after each appointment.

required
object (FormJson)
options
object

The options of the medical form.

shared
boolean

If true, the medical form is shared among all providers.

specialties
Array of arrays

The IDs of the provider specialties to which the form is associated (if it's a shared form).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "doctor_id": "string",
  • "type": "noteForm",
  • "name": "string",
  • "auto_appointment": true,
  • "auto_when_connected": true,
  • "auto_after_each": true,
  • "form": {
    },
  • "options": { },
  • "shared": true,
  • "specialties": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "doctor_id": "string",
  • "type": "noteForm",
  • "name": "string",
  • "auto_appointment": true,
  • "auto_when_connected": true,
  • "auto_after_each": true,
  • "form": {
    },
  • "options": { },
  • "shared": true,
  • "specialties": [ ]
}

Delete an existing medical form

Use this route to delete an existing medical form.

path Parameters
id
required
string

The ID of the medical form to delete.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
"string"

Get all existing rules

Use this route to get the currently configured rules.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new rule

Use this route to create a new rule.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
name
string

The name of the rule.

event
string

The event that triggers the rule.

order
integer

The order of the execution of the rule when there are multiple rules for the same event.

action
string

The action that the rule performs.

hour
string

The hour at which the rule is executed when the event is "everyDay".

disabled
boolean

If true, the rule is disabled.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "event": "string",
  • "order": 0,
  • "action": "string",
  • "hour": "string",
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "event": "string",
  • "order": 0,
  • "action": "string",
  • "hour": "string",
  • "disabled": true
}

Get an existing rule

Use this route to get a specific rule by its unique ID.

path Parameters
id
required
string

The ID of the rule to retrieve.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "event": "string",
  • "order": 0,
  • "action": "string",
  • "hour": "string",
  • "disabled": true
}

Update an existing rule

Use this route to update an existing rule. You can pass only the properties that you want to update.

path Parameters
id
required
string

The ID of the rule to update.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
name
string

The name of the rule.

event
string

The event that triggers the rule.

order
integer

The order of the execution of the rule when there are multiple rules for the same event.

action
string

The action that the rule performs.

hour
string

The hour at which the rule is executed when the event is "everyDay".

disabled
boolean

If true, the rule is disabled.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "event": "string",
  • "order": 0,
  • "action": "string",
  • "hour": "string",
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "event": "string",
  • "order": 0,
  • "action": "string",
  • "hour": "string",
  • "disabled": true
}

Delete an existing rule

Use this route to delete an existing rule.

path Parameters
id
required
string

The ID of the rule to delete.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
"string"

Get all existing tags

Use this route to get the currently configured tags.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new tags

Use this route to create new tags.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
section
string

The section of the tags.

provider_profile
boolean

If true, the tags will appear in the provider profile.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "section": "string",
  • "provider_profile": true,
  • "tags": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get an existing tag

Use this route to get a specific tag by its unique ID.

path Parameters
id
required
string

The ID of the tag to retrieve.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "tag_id": 0,
  • "key": "string",
  • "name": "string",
  • "section": "string",
  • "parent_id": "string",
  • "provider_visible": true
}

Update an existing tag

Use this route to update an existing tag. The tag_id property is required.

path Parameters
id
required
string

The ID of the tag to update.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Request Body schema: application/json
tag_id
integer

The numeric ID of the tag.

key
string

The key of the tag, generated automatically on creation.

name
string

The name of the tag.

section
string

The section of the tag.

parent_id
string

The ID of the parent tag.

provider_visible
boolean

If true, the tag is visible to the providers.

Responses

Request samples

Content type
application/json
{
  • "tag_id": 0,
  • "key": "string",
  • "name": "string",
  • "section": "string",
  • "parent_id": "string",
  • "provider_visible": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tag_id": 0,
  • "key": "string",
  • "name": "string",
  • "section": "string",
  • "parent_id": "string",
  • "provider_visible": true
}

Delete an existing tag

Use this route to delete an existing tag.

path Parameters
id
required
string

The ID of the tag to delete.

header Parameters
Authorization
required
string <Bearer [API key token]>

The API authorization header.

Responses

Response samples

Content type
application/json
"string"