Aller au contenu

Galaxie Artibox

Envoi du lien · Référence de l'API

Envoyer le lien d'un type par courriel ou SMS, et le relancer.

Envoyer le lien d'un type par courriel ou SMS

POST/types/{id}/link-sends

Portée : liens:ecrire Créer des liens uniques, des liens signés et des envois de lien

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: email|sms, name, email?, phone?, subject?, text?}` — variables {prenom}, {nom}, {type}, {organisateur}, {lien}

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/types/{id}/link-sends' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"channel":"email","name":"Camille Martin","email":"camille.martin@example.com"}'

Réponses

  • 201 Créé
  • 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

Relancer un envoi du lien

POST/link-sends/{id}/remind

Portée : liens:ecrire Créer des liens uniques, des liens signés et des envois de lien

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

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