Create WhatsApp instance

curl --request POST \ --url https://api.notifique.dev/v1/whatsapp/instances \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Support", "mode": "UNOFFICIAL" } '

{ "success": true, "data": { "instance": { "id": "inst_abc", "name": "Support", "status": "PENDING", "phoneNumber": null, "mode": "UNOFFICIAL" }, "connection": { "status": "pending_qr", "base64": "data:image/png;base64,...", "code": "2@...", "count": 1 } } }

Authorizations

Authorization

string

header

required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Body

application/json

name

string

required

Friendly name to identify this number in the dashboard (e.g. Support, Sales).

Required string length: 3 - 1024

expectedPhoneNumber

string

Optional. International number you expect to connect (e.g. 5511999999999). Scanning a different SIM returns 409.

Required string length: 10 - 20

generateShareableLink

boolean

default:false

Returns a link for someone else to finish connection. Use true when the person scanning or signing in with Meta is not on your screen. Omit or use false to get the QR in the response and show it in your UI.

metaEmbeddedCode

string

Code from Facebook after Meta signup in the browser (Embedded Signup). Required on the official line unless you use a shareable link.

metaPhoneNumberId

string

Meta Phone Number ID (official line).

metaWabaId

string

WhatsApp Business Account ID on Meta (official line).

metaBusinessId

string

Optional Business Portfolio ID on Meta.

metaPin

string

Optional registration PIN for the number on Meta Cloud API.

mode

enum<string>

Connection type. UNOFFICIAL (default): QR on the phone, good for testing. OFFICIAL: Meta line (browser signup or link for the customer). OFFICIAL_BYOK: Meta line with token and IDs you already have. OFFICIAL_BSP: reserved.

Available options:

UNOFFICIAL,

OFFICIAL,

OFFICIAL_BYOK,

OFFICIAL_BSP

metaAccessToken

string

Permanent Meta access token (BYOK — bring your own credentials).

Response

Number registered. If connection is still pending, the response includes a QR (connection.base64) or a link (shareableLink) to finish setup.

success

boolean

Example:

true

data

object

Show child attributes