422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Book a slot
POST/bookings
Scope : reservations:ecrireCreate, reschedule, cancel and mark bookings; manage polls
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
List the messages sent or planned for a booking
GET/bookings/{id}/sends
Scope : reservations:lireRead bookings and polls
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/sends' \
-H "x-api-key: $RDV_TOKEN"
Responses
200 Success
401 Missing, unknown or expired token
403 Missing scope or right refused
404 Not found (or another organisation's)
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Read a group booking's session and its registrants
GET/bookings/{id}/session
Scope : reservations:lireRead bookings and polls
Parameters
Name
In
Type
Required
Description
id
path
string (uuid)
yes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/session' \
-H "x-api-key: $RDV_TOKEN"
Responses
200 Success
401 Missing, unknown or expired token
403 Missing scope or right refused
404 Not found (or another organisation's)
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Cancel a booking
POST/bookings/{id}/cancel
Scope : reservations:ecrireCreate, reschedule, cancel and mark bookings; manage polls
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.
Request body
`{reason?, channels?: [email|sms]}` — 8.1 : sans `channels`, tous les messages d'annulation actifs
Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/cancel' \
-H "x-api-key: $RDV_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{"reason":"Empêchement de dernière minute","channels":["email"]}'
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Reschedule a booking
POST/bookings/{id}/move
Scope : reservations:ecrireCreate, reschedule, cancel and mark bookings; manage polls
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.
422 Data refused: details are given field by field
429 Too many calls: wait for Retry-After
Mark a booking (honoured, no-show)
POST/bookings/{id}/observe
Scope : reservations:ecrireCreate, reschedule, cancel and mark bookings; manage polls
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
id
path
string
yes
Idempotency-Key
header
string
no
Une clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.