Skip to main content
POST
/
api
/
v1
/
whatsapp-link-sessions
/
cURL
curl --request POST \
  --url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-link-sessions/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "successUrl": "<string>",
  "returnUrl": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "successUrl": "<string>",
  "returnUrl": "<string>",
  "linkUrl": "<string>"
}
This endpoint lets you create a new WhatsApp Account Link Session.

Authorizations

​
X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Body

application/json
​
successUrl
string<uri>
required
​
returnUrl
string<uri>
required

Response

201 - application/json
​
id
string<uuid>
required
read-only
​
successUrl
string<uri>
required
​
returnUrl
string<uri>
required
​
status
enum<string>
required
  • PENDING - Pending
  • EXPIRED - Expired
  • SUCCESS - Success
  • FAILED - Failed
Available options:
PENDING,
EXPIRED,
SUCCESS,
FAILED
​
linkUrl
string
required
read-only