Whatsapp Signup

Create a Whatsapp hosted signup

Changed on

Create a time-limited onboarding URL on the Telnyx-hosted Embedded Signup page for a Tech Provider's end customer. Set signup_type to coexistence to launch Meta's WhatsApp Business app coexistence flow instead of standard Cloud API onboarding.

post/whatsapp/hosted_signups

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/whatsapp/hosted_signups
  • Auth: HTTP bearer

Request body

app_idstring required

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

expires_atstring 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.

signup_type'standard' | 'coexistence'

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

Example request

{
  "app_id": "123456789012345",
  "expires_at": "2026-07-09T12:00:00Z",
  "signup_type": "coexistence"
}

Response

Hosted signup created

Example response

{
  "data": {
    "id": "0192345a-7b8c-7d9e-0f12-3456789abcde",
    "record_type": "whatsapp_jwt",
    "app_id": "123456789012345",
    "solution_id": "987654321098765",
    "created_at": "2026-07-08T12:00:00Z",
    "expires_at": "2026-07-09T12:00:00Z",
    "jwt": "eyJhbGciOiJSUzI1NiIs...",
    "url": "https://acct.fyi?token=eyJhbGciOiJSUzI1NiIs..."
  }
}

Changes