422 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Réserver un créneau
POST/bookings
Portée : reservations:ecrireCréer, déplacer, annuler et constater les rendez-vous ; gérer les sondages
Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.
Paramètres
Nom
Où
Type
Obligatoire
Description
Idempotency-Key
en-tête
string
non
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 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Lister les messages envoyés ou prévus pour un rendez-vous
GET/bookings/{id}/sends
Portée : reservations:lireLire les rendez-vous et les sondages
Paramètres
Nom
Où
Type
Obligatoire
Description
id
chemin
string
oui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/sends' \
-H "x-api-key: $RDV_TOKEN"
Réponses
200 Réussi
401 Jeton absent, inconnu ou expiré
403 Portée manquante ou droit refusé
404 Introuvable (ou d'une autre organisation)
422 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Lire la séance d'un rendez-vous de groupe et ses inscrits
GET/bookings/{id}/session
Portée : reservations:lireLire les rendez-vous et les sondages
Les inscrits qui partagent l'organisateur et le début de ce rendez-vous (format « groupe »), annulés compris, avec leur statut. Mêmes droits que la fiche du rendez-vous. Jeton : portée `reservations:lire`.
Paramètres
Nom
Où
Type
Obligatoire
Description
id
chemin
string (uuid)
oui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/session' \
-H "x-api-key: $RDV_TOKEN"
Réponses
200 Réussi
401 Jeton absent, inconnu ou expiré
403 Portée manquante ou droit refusé
404 Introuvable (ou d'une autre organisation)
422 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Annuler un rendez-vous
POST/bookings/{id}/cancel
Portée : reservations:ecrireCréer, déplacer, annuler et constater les rendez-vous ; gérer les sondages
Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.
Paramètres
Nom
Où
Type
Obligatoire
Description
id
chemin
string
oui
Idempotency-Key
en-tête
string
non
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.
Corps de la requête
`{reason?, channels?: [email|sms]}` — 8.1 : sans `channels`, tous les messages d'annulation actifs
Exemple de requête
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 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Déplacer un rendez-vous
POST/bookings/{id}/move
Portée : reservations:ecrireCréer, déplacer, annuler et constater les rendez-vous ; gérer les sondages
Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.
Paramètres
Nom
Où
Type
Obligatoire
Description
id
chemin
string
oui
Idempotency-Key
en-tête
string
non
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 Données refusées : le détail est donné champ par champ
429 Trop d'appels : attendez Retry-After
Constater un rendez-vous (honoré, absent)
POST/bookings/{id}/observe
Portée : reservations:ecrireCréer, déplacer, annuler et constater les rendez-vous ; gérer les sondages
Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.
Paramètres
Nom
Où
Type
Obligatoire
Description
id
chemin
string
oui
Idempotency-Key
en-tête
string
non
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.