Skip to main content
POST
/
v1
/
invitations
curl --request POST \
  --url https://api.zavu.dev/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientName": "Acme Corp"
}
'
{
  "invitation": {
    "id": "inv_abc123",
    "url": "https://dashboard.zavu.dev/invite/abc123xyz",
    "token": "<string>",
    "status": "pending",
    "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:

"contact@acme.com"

​
clientPhone
string

Phone number of the client in E.164 format.

Example:

"+14155551234"

​
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

Invitation created.

​
invitation
object
required