Cancel sending

API 0.16.0OpenAPIllms-full.txt

POST/v1/operations/{operation_id}/cancel

Cancels sending a message while the operation is in state queued. If the sending has already started, completed or was cancelled, a 409 is returned. You cannot recall an already sent message using this method.

Authentication and access · Errors and retries

Request

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

Parameters

operation_idpathNecessarily

string · uuid

X-Customer-IDheader

Option 1

string

Option 2

null

Responses

200 Successful response

application/json

object

cancelled

boolean

401 Login required

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

403 No access

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

404 Resource not found

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

409 State conflict

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

422 Validation error

application/json

object

detail

array

Array elements

object

locNecessarily

array

Array elements

Option 1

string

Option 2

integer

msgNecessarily

string

typeNecessarily

string

503 Temporarily unavailable

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object