Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
app_id
string
required

Meta App ID linked to the Telnyx account. The app must be enabled.

Example:

"123456789012345"

expires_at
string<date-time>

When the onboarding URL expires, in RFC 3339 format. Must be in the future and at most 3 days ahead. Defaults to 24 hours after creation.

Example:

"2026-07-09T12:00:00Z"

signup_type
enum<string>
default:standard

Onboarding flow the hosted page launches. Use coexistence for a number that remains active in the WhatsApp Business app.

Available options:
standard,
coexistence
Example:

"coexistence"

Response

Hosted signup created

data
object