Skip to content

Type messages · API reference

The messages sent to an event type's guests (confirmation, reminder…).

Read an event type's messages

GET/types/{id}/messages

Scope : types:lire Read event types, their slots and messages

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/types/{id}/messages' \
  -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

Update an event type's messages

PUT/types/{id}/messages

Scope : types:ecrire Create, change and delete event types

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/types/{id}/messages' \
  -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

Preview a message

POST/types/{id}/messages/preview

Scope : types:ecrire Create, change and delete event types

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
idpathstringyes
Idempotency-KeyheaderstringnoUne 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

`{channel, locale, subject?, body}`

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/types/{id}/messages/preview' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After