The Invitations API from Zavu — 3 operation(s) for invitations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zavu:zavu-invitations-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Zavu Unified Messaging Layer Invitations API
version: 0.2.0
description: Unified multi-channel messaging API for Zavu.
servers:
- url: https://api.zavu.dev
security:
- bearerAuth: []
tags:
- name: Invitations
paths:
/v1/invitations:
post:
summary: Create invitation
description: 'Create a partner invitation link for a client to connect WhatsApp. The client opens the returned `url` and connects. Set `connectionType` to choose how they connect:
- `whatsapp_waba` (default): the client completes Meta''s embedded signup, linking an official WhatsApp Business Account.
- `whatsapp_alt`: the client links their number by scanning a QR code. Requires the WhatsApp Alternative feature to be enabled for your team (otherwise returns 400).
Either way, the resulting sender is created in your project when the client completes the flow, and the invitation transitions to `completed`.'
operationId: createInvitation
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/InvitationCreateRequest'
examples:
basic:
summary: Basic invitation
value:
clientName: Acme Corp
full:
summary: Full invitation with all options
value:
clientName: Acme Corp
clientEmail: contact@acme.com
clientPhone: '+14155551234'
expiresInDays: 14
allowedPhoneCountries:
- US
- MX
whatsapp_alt:
summary: QR-linked WhatsApp (WhatsApp Alternative)
value:
clientName: Acme Corp
clientEmail: contact@acme.com
connectionType: whatsapp_alt
responses:
'201':
description: Invitation created.
content:
application/json:
schema:
$ref: '#/components/schemas/InvitationResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
tags:
- Invitations
get:
summary: List invitations
description: List partner invitations for this project.
operationId: listInvitations
parameters:
- name: status
in: query
schema:
$ref: '#/components/schemas/InvitationStatus'
- name: limit
in: query
schema:
type: integer
default: 50
maximum: 100
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: List of invitations.
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/Invitation'
nextCursor:
type:
- string
- 'null'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
tags:
- Invitations
/v1/invitations/{invitationId}:
get:
summary: Get invitation
operationId: getInvitation
parameters:
- $ref: '#/components/parameters/InvitationIdParam'
responses:
'200':
description: Invitation details.
content:
application/json:
schema:
$ref: '#/components/schemas/InvitationResponse'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Invitation not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
tags:
- Invitations
/v1/invitations/{invitationId}/cancel:
post:
summary: Cancel invitation
description: Cancel an active invitation. The client will no longer be able to use the invitation link.
operationId: cancelInvitation
parameters:
- $ref: '#/components/parameters/InvitationIdParam'
responses:
'200':
description: Invitation cancelled.
content:
application/json:
schema:
$ref: '#/components/schemas/InvitationResponse'
'400':
description: Cannot cancel this invitation (already completed or cancelled).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Invitation not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
tags:
- Invitations
components:
schemas:
InvitationCreateRequest:
type: object
properties:
clientName:
type: string
maxLength: 100
description: Name of the client being invited.
example: Acme Corp
clientEmail:
type: string
format: email
description: Email of the client being invited.
example: contact@acme.com
clientPhone:
type: string
description: Phone number of the client in E.164 format.
example: '+14155551234'
phoneNumberId:
type: string
description: 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:
type: integer
minimum: 1
maximum: 30
default: 7
description: Number of days until the invitation expires.
allowedPhoneCountries:
type: array
items:
type: string
minLength: 2
maxLength: 2
description: ISO country codes for allowed phone numbers.
example:
- US
- MX
connectionType:
type: string
enum:
- whatsapp_waba
- whatsapp_alt
default: whatsapp_waba
description: How the client connects WhatsApp. `whatsapp_waba` (default) runs Meta's embedded signup to link an official WhatsApp Business Account. `whatsapp_alt` links the number by scanning a QR code — available only to teams with the WhatsApp Alternative feature enabled.
InvitationResponse:
type: object
required:
- invitation
properties:
invitation:
$ref: '#/components/schemas/Invitation'
Invitation:
type: object
required:
- id
- url
- token
- status
- expiresAt
- createdAt
- updatedAt
properties:
id:
type: string
example: inv_abc123
url:
type: string
description: Full URL to share with the client.
example: https://dashboard.zavu.dev/invite/abc123xyz
token:
type: string
description: Unique invitation token.
clientName:
type:
- string
- 'null'
clientEmail:
type:
- string
- 'null'
clientPhone:
type:
- string
- 'null'
phoneNumberId:
type:
- string
- 'null'
description: ID of a pre-assigned Zavu phone number for WhatsApp registration.
connectionType:
type: string
enum:
- whatsapp_waba
- whatsapp_alt
description: 'How the client connects WhatsApp: `whatsapp_waba` (official Cloud API via embedded signup) or `whatsapp_alt` (QR-linked).'
status:
$ref: '#/components/schemas/InvitationStatus'
senderId:
type:
- string
- 'null'
description: ID of the sender created when invitation is completed.
expiresAt:
type: string
format: date-time
viewedAt:
type:
- string
- 'null'
format: date-time
startedAt:
type:
- string
- 'null'
format: date-time
completedAt:
type:
- string
- 'null'
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
InvitationStatus:
type: string
description: Current status of the partner invitation.
enum:
- pending
- in_progress
- completed
- expired
- cancelled
Error:
type: object
required:
- code
- message
properties:
code:
type: string
example: invalid_request
message:
type: string
example: Phone number is invalid
details:
type: object
additionalProperties: true
parameters:
InvitationIdParam:
name: invitationId
in: path
required: true
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT