Aller au contenu

Galaxie Artibox

Messages par type · Référence de l'API

Les messages envoyés aux invités d'un type (confirmation, rappel…).

Lire les messages d'un type

GET/types/{id}/messages

Portée : types:lire Lire les types de rendez-vous, leurs créneaux et leurs messages

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/types/{id}/messages' \
  -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

Modifier les messages d'un type

PUT/types/{id}/messages

Portée : types:ecrire Créer, modifier et supprimer les types de rendez-vous

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

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

Prévisualiser un message

POST/types/{id}/messages/preview

Portée : types:ecrire Créer, modifier et supprimer les types de rendez-vous

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Idempotency-Keyen-têtestringnonUne 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

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

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

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)
  • 409 Conflit : créneau pris ou requête en cours
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After