Sandbox Testing

Below are a list of test values you can use in the Sandbox environment to mimic real-world scenarios.

Test values are passed to to.address, which is the address field on the to object in the /mail POST data.

Simply pass the to.address values below in a POST {formType}/{documentId}/mail API call to experience the corresponding scenario. Webhooks fire for all status changes.


Test Scenarios

to.addressScenarioDescription
PROCESSING_FOR_DELIVERYMailing successfully createdThis scenario will return a response with a status of PROCESSING_FOR_DELIVERY. This will send a MAILING_PROCESSING_FOR_DELIVERY webhook.
IN_TRANSITMailing is en-routeThis scenario will return a response with a status of IN_TRANSIT. This will send a MAILING_PROCESSING_FOR_DELIVERY webhook, followed by a MAILING_IN_TRANSIT webhook.
DELIVEREDMailing has arrived at its destinationThis scenario will return a response with a status of DELIVERED. This will send a MAILING_PROCESSING_FOR_DELIVERY webhook, followed by a MAILING_IN_TRANSIT webhook, followed by a MAILING_DELIVERED webhook.
RETURNED_TO_SENDERMailing was undeliverableThis scenario will return a response with a status of RETURNED_TO_SENDER. This will send a MAILING_PROCESSING_FOR_DELIVERY webhook, followed by a MAILING_IN_TRANSIT webhook, followed by a MAILING_RETURNED_TO_SENDER webhook.

Any value other than the test values above will result in a CREATED status.