Skip to navigation

List routes

List the routes defined for an inbound domain or SMS program. Provide either domain or phone (not both).

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
domainstringOptionalformat: "hostname"

The domain to check (required if phone is not provided)

phonestringOptional

The SMS program phone number (required if domain is not provided)

Response

Success
idstring
The unique identifier of the route
patternstring
The search pattern that the mailbox name should match
urlstringformat: "uri"
The webhook URL where inbound messages will be published

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error