Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

application/json
from
string
required

Phone number simulating the external user (the sender). E.164 format required.

Example:

"+15559876543"

to
string
required

Your Chirp phone number that should receive the simulated message. E.164 format required.

Example:

"+15551234567"

text
string
required

Message text content to deliver to your webhook.

Minimum string length: 1
Example:

"Hello from a simulated user!"

subject
string

Optional subject line (MMS-style).

Example:

"Subject line"

Response

Inbound message queued for processing

id
string
required

ID of the queued incoming webhook event.

status
enum<string>
required

The simulated message has been accepted and queued for delivery to your webhook.

Available options:
QUEUED