Skip to main content
PATCH
Change a data area

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

id
enum<string>
required

Data area: agenda, team (services and team), patients (administrative data), clinical (clinical history) or billing.

Available options:
agenda,
team,
patients,
clinical,
billing

Body

application/json
enabled
boolean
required
expectedVersion
integer
required

The version you read; if someone changed the area first, the answer is 409.

Required range: 0 <= x <= 9007199254740991
acceptTerms
boolean
default:false

Brelio only: accept the patient-data terms when turning a patient area on.

termsVersion
integer

Brelio only: the terms version the person read; it must be the current one.

Required range: 1 <= x <= 9007199254740991

Response

Success

id
enum<string>
required

Data area: agenda, team (services and team), patients (administrative data), clinical (clinical history) or billing.

Available options:
agenda,
team,
patients,
clinical,
billing
label
string
required
description
string
required
patientData
boolean
required
enabled
boolean
required
version
integer
required

Version of the area; 0 while it is on its default. Send it back as expectedVersion.

Required range: -9007199254740991 <= x <= 9007199254740991
updatedAt
string<date-time> | null
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))$