Skip to main content
POST
Queue a generated mailing ZIP export

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

generated_mailing_ids
integer[]
required

Generated mailing ids. Validation: required, array, min:1.

Minimum array length: 1

Generated mailing ids item. Validation: integer.

document_kind
enum<string> | null

Document kind. Validation: nullable, string, in:all,letter,label; allowed values: all, letter, label.

Available options:
all,
letter,
label,
null
Example:

"all"

Response

Operation result.

message
string
Example:

"Bulk export queued."

status
enum<string>
Available options:
queued
Example:

"queued"

export_id
integer

Organization-owned record identifier.

Example:

42

status_url
string | null

API path without the version prefix; call the corresponding documented v1 endpoint.

Example:

"/admin/mailings/42/artifact/letter"