Annuler l'envoi

API 0.16.0OpenAPIllms-full.txt

POST/v1/operations/{operation_id}/cancel

Annule l'envoi d'une lettre alors que l'opération est dans l'état queued. Si l'envoi a déjà commencé, terminé ou a été annulé, un 409 est renvoyé. Vous ne pouvez pas rappeler une lettre déjà envoyée en utilisant cette méthode.

Zones d’autorisation et d’accès · Erreurs et répétitions

Demande

curl -X POST 'https://adapt-mail.com/v1/operations/<operation_id>/cancel' \
  -H 'Authorization: Bearer <access_token>'

Possibilités

operation_idpathNécessairement

string · uuid

X-Customer-IDheader

Option 1

string

Option 2

null

Réponses

200 Réponse réussie

application/json

object

cancelled

boolean

401 Connexion requise

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

403 Pas d'accès

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

404 Ressource introuvable

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

409 Conflit d'État

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

422 Erreur de validation

application/json

object

detail

array

Éléments du tableau

object

locNécessairement

array

Éléments du tableau

Option 1

string

Option 2

integer

msgNécessairement

string

typeNécessairement

string

503 Indisponibilité temporaire

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object