Cancelar envio

API 0.16.0OpenAPIllms-full.txt

POST/v1/operations/{operation_id}/cancel

Cancela o envio de uma carta enquanto a operação estiver no estado queued. Se o envio já foi iniciado, concluído ou foi cancelado, um 409 é retornado. Você não pode recuperar uma carta já enviada usando este método.

Áreas de autorização e acesso · Erros e repetições

Solicitar

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

Opções

operation_idpathNecessariamente

string · uuid

X-Customer-IDheader

Opção 1

string

Opção 2

null

Respostas

200 Resposta bem-sucedida

application/json

object

cancelled

boolean

401 Login necessário

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

403 Sem acesso

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

404 Recurso não encontrado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

409 Conflito de estado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

422 Erro de validação

application/json

object

detail

array

Elementos da matriz

object

locNecessariamente

array

Elementos da matriz

Opção 1

string

Opção 2

integer

msgNecessariamente

string

typeNecessariamente

string

503 Indisponibilidade temporária

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object