Cancel appointment

curl --request POST \
  --url https://api.brelio.app/v1/appointments/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "id": "6a1e4c2b-8d3f-4e5a-9b7c-0d1e2f3a4b5c",
  "expectedVersion": "1"
}
'

{
  "id": "<string>",
  "seriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "durationMinutes": 0,
  "status": "scheduled",
  "professionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "centerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurring": true,
  "version": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

POST

appointments

{id}

cancel

curl --request POST \
  --url https://api.brelio.app/v1/appointments/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "id": "6a1e4c2b-8d3f-4e5a-9b7c-0d1e2f3a4b5c",
  "expectedVersion": "1"
}
'

{
  "id": "<string>",
  "seriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "durationMinutes": 0,
  "status": "scheduled",
  "professionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "centerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurring": true,
  "version": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "params": {},
  "hint": "<string>",
  "retryAfterSeconds": 123
}

Authorizations

Authorization

string

header

required

Brelio API key (organization or user) or a WorkOS access token.

Headers

Idempotency-Key

string

required

Unique per command; reuse it only to retry the same call.

Required string length: 8 - 255

Path Parameters

string

required

The id agenda.list returns, or the appointment series id.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(:.+)?$

Body

application/json

expectedVersion

string

required

The version of the appointment as appointments.get returned it. Do not build it yourself.

Pattern: ^[1-9]\d{0,8}$

reason

string | null

Why it was cancelled, in administrative terms only. Never include clinical information.

Maximum string length: 2000

Response

Success

string

required

The occurrence id, as agenda.list returns it.

seriesId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

start

string<date-time>

required

ISO 8601, UTC.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

end

string<date-time>

required

ISO 8601, UTC.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

durationMinutes

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

status

enum<string>

required

Available options:

scheduled,

checked_in,

in_progress,

needs_review,

completed,

cancelled,

no_show,

voided

professionalId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

serviceId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

patientId

string<uuid> | null

required

The patient; null when the caller may not see patient data.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

centerId

string<uuid> | null

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

recurring

boolean

required

Part of a recurring series; such appointments cannot be changed through the API yet.

version

string

required

Opaque version token. Send it back as expectedVersion to change this appointment; do not parse it.

createdAt

string<date-time>

required

ISO 8601, UTC.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

ISO 8601, UTC.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

calendar

organizations

appointments

scheduling

patients

platform-policy

professionals

services

webhooks

Cancel appointment

Authorizations

Headers

Path Parameters

Body

Response