channels

Create a WhatsApp connect link

Mint a single-use link that lets your customer connect their WhatsApp Business account themselves, no Blueticked login required.

Connecting WhatsApp is a human act performed by the business owner in Meta's Embedded Signup; no API key can do it for them. This turns that step into a link you send, instead of asking your customer to create a Blueticked account and find a screen.

The url is returned ONCE and is not stored in plaintext. If you lose it, mint another and let this one expire.

The link is single-use, expires (default 24 hours, 5 minutes to 7 days), and authorises exactly one thing: attaching a WhatsApp channel to this workspace. It cannot read, send, or write anything else.

reference is opaque to us and comes back on the channel.connected webhook, so you can match a completed connect to your own customer record without storing a map of our ids.

redirect_url must be https: your customer's browser follows it after a successful connect.

Pass business_id to say WHOSE channel this becomes. Omit it and the link binds to the workspace default business, which silently collapses every customer onto one. The sends still return 202, from the wrong number.

Subscribe to channel.connected to learn when your customer finished; it fires once per connect. If you would rather poll, GET /api/v1/readiness?business_id=... flips can_send.whatsapp to true for THAT business. Either way, do not ask your customer whether they finished.

post/api/v1/channels/connect-sessions

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/channels/connect-sessions
  • Auth: HTTP bearer

Request body

business_idstring uuid
expires_in_minutesnumber
referencestring
redirect_urlstring

Example request

{
  "business_id": "22222222-2222-4222-9222-222222222222",
  "expires_in_minutes": 1440,
  "reference": "your-customer-id-8842",
  "redirect_url": "https://yourapp.example/onboarding/whatsapp/done"
}

Response

Success

idstring uuid required
urlstring required
expires_atstring date-time required
business_idstring uuid required
referencestring nullable required
request_idstring required

Example response

{
  "id": "55da18e2-8acb-46cb-9d58-1bc94a287783",
  "url": "https://app.blueticked.com/connect/8Kq2v...",
  "expires_at": "2026-08-10T03:00:00.000Z",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "reference": "your-customer-id-8842",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

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