Channels

Create a WhatsApp signup link

A Meta Embedded Signup URL for this project, to hand to the person who owns the WhatsApp number. They sign in with Meta, pick or create the business account and number, and the number is linked to the project as a channel with credential_source: embedded_signup when they finish. No popup or naturali session is needed to follow it.

The link only links the number: the channel starts with default: { action: silence }, so it answers nothing until an agent is bound to it with PATCH /v1/projects/{project_id}/channels/{channel_id} or a route.

The link is good for 30 minutes and acts for whoever created it: it stops working if they leave the project. A number not yet registered for sending is registered with a two-step verification PIN naturali generates and does not keep; the owner can reset it in WhatsApp Manager. Returns 501 on deployments where Meta signup is not configured.

post/v1/projects/{project_id}/channels/whatsapp/signup-links

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/channels/whatsapp/signup-links
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Response

Link created.

urlstring uri required

The Meta dialog to open. Treat it as a credential.

expires_atstring date-time required

Example response

{
  "url": "https://www.facebook.com/v25.0/dialog/oauth?client_id=1234567890",
  "expires_at": "2026-10-08T12:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.