Skip to main content
POST
Create a mailing request

Authorizations

Authorization
string
header
required

access token

Body

multipart/form-data
parameters
string
required

JSON-encoded object containing mailing parameters

Example:

"{\"mailType\":\"certified\",\"mailingConfig\":{},\"idempotencyKey\":\"2720f109-0caf-4c62-af22-5d08c853711c\",\"recipient\":{\"name\":\"John Doe\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zipcode\":\"10001\"}}"

pdf
file
required

PDF file to be mailed (maximum 10 MiB)

Response

Mailing successfully queued for delivery

id
string<uuid>

Unique identifier for the created mailing

Example:

"a79f3a6b-3fa8-4007-b9b7-824cb8ca7031"