Skip to content

Link sends · API reference

Send an event type's link by email or SMS, and remind.

Send an event type's link by email or SMS

POST/types/{id}/link-sends

Scope : liens:ecrire Create single-use links, signed links and link sends

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

Request example
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"}'

Responses

  • 201 Created
  • 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

Remind a link send

POST/link-sends/{id}/remind

Scope : liens:ecrire Create single-use links, signed links and link sends

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

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