Отменить отправку

API 0.16.0OpenAPIllms-full.txt

POST/v1/operations/{operation_id}/cancel

Отменяет отправку письма, пока операция находится в состоянии queued. Если отправка уже началась, завершилась или была отменена, возвращается 409. Отозвать уже отправленное письмо этим методом нельзя.

Авторизация и области доступа · Ошибки и повторы

Запрос

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

Параметры

operation_idpathОбязательно

string · uuid

X-Customer-IDheader

Вариант 1

string

Вариант 2

null

Ответы

200 Успешный ответ

application/json

object

cancelled

boolean

401 Требуется вход

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Нет доступа

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ресурс не найден

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

409 Конфликт состояния

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка валидации

application/json

object

detail

array

Элементы массива

object

locОбязательно

array

Элементы массива

Вариант 1

string

Вариант 2

integer

msgОбязательно

string

typeОбязательно

string

503 Временная недоступность

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object