Create invitation

Create a partner invitation link for a client to connect their WhatsApp Business account. The client will complete Meta’s embedded signup flow and the resulting sender will be created in your project.

POST /v1/invitations

cURL

basic

curl --request POST \
  --url https://api.zavu.dev/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientName": "Acme Corp"
}
'

201

{
  "invitation": {
    "id": "inv_abc123",
    "url": "https://dashboard.zavu.dev/invite/abc123xyz",
    "token": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "clientName": "<string>",
    "clientEmail": "<string>",
    "clientPhone": "<string>",
    "phoneNumberId": "<string>",
    "senderId": "<string>",
    "viewedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

clientName · string

Name of the client being invited.

Maximum string length: 100

Example:

"Acme Corp"

clientEmail · string<email>

Email of the client being invited.

Example:

"[e-mail]"

clientPhone · string

Phone number of the client in E.164 format.

Example:

"[phone]"

phoneNumberId · string

ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided, the client will use this number instead of their own.

Example:

"pn_abc123"

expiresInDays · integer · default: 7

Number of days until the invitation expires.

Required range: 1 <= x <= 30

allowedPhoneCountries · string[]

ISO country codes for allowed phone numbers.

Required string length: 2

Example:

["US", "MX"]

Response

201

application/json

Invitation created.

invitation · object · required

Show child attributes