/queue/actions

POST

/queue/actions

const url = 'https://example.com/api/v1/queue/actions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"action":"hold","ids":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/queue/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "hold", "ids": [ "example" ] }'

Hold (postsuper -h), release (postsuper -H) or delete (postsuper -d) queued messages. Ids a domain_admin cannot see are refused as a whole request rather than silently skipped. Deleting is irreversible: Postfix has no undelete.

Authorizations

bearer

Request Body^required

application/json

object

action

required

string

Allowed values: hold release delete

ids

required

Array<string>

>= 1 items <= 200 items

Responses

200

Default Response

application/json

object

action

required

string

Allowed values: hold release delete

requested

required

integer

>= -9007199254740991 <= 9007199254740991

affected

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

output

required

string

Example

{
  "action": "hold"
}

/queue/actions

Authorizations

Request Bodyrequired

Responses

200

Example

Request Body^required