> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zavu.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.json post /v1/invitations
openapi: 3.0.3
info:
  title: Zavu Unified Messaging Layer API
  version: 0.2.0
  description: >
    Unified multi-channel messaging API for Zavu.


    Supported channels:

    - **SMS**: Simple text messages

    - **WhatsApp**: Rich messaging with media, buttons, lists, CTA URL buttons,
    and templates

    - **Telegram**: Bot messaging with text, media, and interactive elements

    - **Email**: Transactional emails via Amazon SES


    Design goals:

    - Simple `send()` entrypoint for developers

    - Project-level authentication via Bearer token

    - Support for all WhatsApp message types (text, image, video, audio,
    document, sticker, location, contact, buttons, list, cta_url, reaction,
    template)

    - If a non-text message type is sent, WhatsApp channel is used automatically

    - 24-hour WhatsApp conversation window enforcement

    - Universal `to` field accepts phone numbers (E.164), email addresses, or
    numeric chat IDs (Telegram/Instagram)
servers:
  - url: https://api.zavu.dev
security:
  - bearerAuth: []
paths:
  /v1/invitations:
    post:
      summary: Create invitation
      description: >-
        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.
      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
      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: []
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
    InvitationResponse:
      type: object
      required:
        - invitation
      properties:
        invitation:
          $ref: '#/components/schemas/Invitation'
    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
    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
          nullable: true
        clientEmail:
          type: string
          nullable: true
        clientPhone:
          type: string
          nullable: true
        phoneNumberId:
          type: string
          nullable: true
          description: ID of a pre-assigned Zavu phone number for WhatsApp registration.
        status:
          $ref: '#/components/schemas/InvitationStatus'
        senderId:
          type: string
          nullable: true
          description: ID of the sender created when invitation is completed.
        expiresAt:
          type: string
          format: date-time
        viewedAt:
          type: string
          format: date-time
          nullable: true
        startedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````