Skip to navigation

Add route

Add a new route to 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"

An existing inbound domain (required if phone is not provided)

phonestringOptional

The SMS program phone number - the TO number that receives inbound SMS (required if domain is not provided)

patternstringOptional

For email: the mailbox pattern (e.g., “mailbox-*”). For SMS: not used, the phone number is the pattern.

urlstringOptionalformat: "active-uri"
The webhook URL where the inbound messages will be published

Response

Success

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error