Send a test text to yourself

Send a campaign's text message to a number you choose. The campaign's SMS channel must be enabled and have a template; otherwise 400. The test isn't added to the campaign's recipient count, but it uses the plan's SMS allowance (402 when used up).

Prerequisites: a bearer token, and a campaign in your account whose SMS channel is enabled and has a template, on a location with an active plan.

Authentication: Account token. The campaign must belong to your own account; otherwise 403.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 4666

The campaign to test. Must exist (otherwise 422) and belong to your own account (otherwise 403).

string
required
length ≤ 255
Defaults to Jane Smith

The name to use in the text, up to 255 characters.

string
required
length between 7 and 20
Defaults to +15555550100

Where to send the test, 7–20 characters. Include the country code.

boolean
Defaults to true

true marks the send as a test in reporting. Default false.

keywords
object

Values for your template's placeholders, as key/value pairs, e.g. {"paragraph_1": "Thanks for visiting!"}. Each key up to 100 characters; values are strings. Empty values are skipped.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json