API ReferenceMailings

Update a mailing

Updates an existing mailing. Once a mailing has reached the PROCESSING_FOR_DELIVERY status, it cannot be updated. Any body parameters not provided will be removed.

Path parameters

mailingIdstringRequired

The unique identifier for an existing mailing.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringOptional

The unique key used to identify a request that has already been processed.

Request

This endpoint expects an object.
toobjectRequired

The mailing address of the recipient.

fromobjectRequired

The mailing address of the sender.

Response

OK

createdAtdatetime

The creation date and time of the mailing in ISO 8601 format.

fromobject

The mailing address of the sender.

idstring

The unique identifier for this mailing.

mailedFromIdstring

The documentId of the mailed document.

statusenum

The status of the mailing.

Allowed values:
toobject

The mailing address of the recipient.

urlstring

The URL to the mailed document.

userIdstringOptional

The unique identifier for a single end-user of your application.

Errors