Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Headers

Idempotency-Key
string

Accepted but not used for replay on this operation. Only POST /v1/partner/consultations stores and replays responses by Idempotency-Key.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Path Parameters

consultation_id
string<uuid>
required

The consultation id.

Response

The cancelled consultation.

id
string<uuid>
required

The consultation id.

object
enum<string>
required

Always consultation.

Available options:
consultation
mode
enum<string>
required

test or live, from the API key.

Available options:
live,
test
status
enum<string>
required

Current consultation status.

Available options:
submitted,
in_review,
info_requested,
approved,
rejected,
cancelled
version
integer
required

Increases with every change to the consultation's public state, i.e. every field of this object except version, status_history, updated_at and product.name (catalogue copy: a product rename does not advance it). Events carry the same number.

status_history
object[]
required

Every status change, oldest first.

external_reference
string | null
required

Your order or case reference; null when none was sent.

product
object
required

The product.

country
string
required

ISO 3166-1 alpha-2 country code.

plan_key
string | null
required

The chosen plan.

dosage
string | null
required

The chosen dosage; null when the product has none.

patient
object
required

The patient.

submitted_at
string<date-time>
required

When the consultation was submitted.

updated_at
string<date-time>
required

When it last changed.

reviewer
required

Present once the reviewing doctor has opened the case.

decision
required

The clinical decision; null until one is recorded.

open_info_request
required

The open information request; null when there is none.

prescriptions
object[]
required

Prescriptions issued for the consultation.

billing
object
required

Billing state and price of the consultation.

cancellable
boolean
required

true exactly when POST /consultations/{consultation_id}/cancel would succeed now: the consultation is submitted, has no prescription, and (live) no doctor has opened it, no decision or electronic prescription signing has started, and no prescription issuance or replacement is in flight.