We're excited to have you on board.
replyTo: support@example.com email_attachment: summary: Email with attachments value: to: user@example.com channel: email subject: Your invoice text: Please find your invoice attached. attachments: - filename: invoice.pdf content: JVBERi0xLjQK... content_type: application/pdf email_inline_image: summary: Email with inline image value: to: user@example.com channel: email subject: Your report text: See your report below. htmlBody:Details above.
attachments: - filename: chart.png path: https://example.com/chart.png content_type: image/png content_id: chart responses: '202': description: Message accepted for delivery. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '400': description: Invalid request or WhatsApp 24h window not open. content: application/json: schema: $ref: '#/components/schemas/Error' examples: window_closed: summary: WhatsApp window closed value: code: whatsapp_window_closed message: >- WhatsApp 24-hour window is not open. Use a template message or wait for user to message first. '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Message blocked due to URL restrictions. content: application/json: schema: $ref: '#/components/schemas/Error' examples: url_not_verified: summary: URL not verified value: code: url_not_verified message: >- Message blocked: Contains unverified URLs. Submit URLs for verification via the /v1/urls endpoint. details: urls: - https://example.com submissionEndpoint: /v1/urls url_shortener_blocked: summary: URL shortener blocked value: code: url_shortener_blocked message: >- Message blocked: URL shorteners are not allowed. Please use the full destination URL. details: blockedUrls: - https://bit.ly/abc123 reason: url_shorteners_hidden_destination '404': description: Template or sender not found. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Idempotency conflict (message already sent). content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: parameters: SenderHeader: name: Zavu-Sender in: header required: false description: >- Optional sender profile ID. If omitted, the project's default sender will be used. schema: type: string example: sender_12345 schemas: MessageRequest: type: object description: Request body to send a message. required: - to properties: to: type: string description: >- Recipient phone number in E.164 format, email address, or numeric chat ID (for Telegram/Instagram). example: '+56912345678' channel: $ref: '#/components/schemas/Channel' description: >- Delivery channel. Use 'auto' for intelligent routing. If omitted, channel is auto-selected based on sender capabilities and recipient type. For email recipients, defaults to 'email'. default: auto messageType: $ref: '#/components/schemas/MessageType' description: Type of message. Defaults to 'text'. default: text text: type: string description: Text body for text messages or caption for media messages. example: Your verification code is 123456. content: $ref: '#/components/schemas/MessageContent' description: Additional content for non-text message types. subject: type: string description: >- Email subject line. Required when channel is 'email' or recipient is an email address. maxLength: 998 example: Your order confirmation htmlBody: type: string description: >- HTML body for email messages. If provided, email will be sent as multipart with both text and HTML. replyTo: type: string format: email description: Reply-To email address for email messages. example: support@example.com idempotencyKey: type: string description: Optional idempotency key to avoid duplicate sends. example: msg_01HZY4ZP7VQY2J3BRW7Z6G0QGE metadata: type: object description: Arbitrary metadata to associate with the message. additionalProperties: type: string fallbackEnabled: type: boolean description: >- Whether to enable automatic fallback to SMS if WhatsApp fails. Defaults to true. default: true voiceLanguage: type: string description: >- Language code for voice text-to-speech (e.g., 'en-US', 'es-ES', 'pt-BR'). If omitted, language is auto-detected from recipient's country code. example: es-ES attachments: type: array description: >- Email attachments. Only supported when channel is 'email'. Maximum 40MB total size. maxItems: 50 items: $ref: '#/components/schemas/EmailAttachmentInput' MessageResponse: type: object required: - message properties: message: $ref: '#/components/schemas/Message' 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 Channel: type: string description: Delivery channel. Use 'auto' for intelligent routing. enum: - auto - sms - sms_oneway - whatsapp - telegram - email - instagram - voice MessageType: type: string description: >- Type of message. Non-text types are supported by WhatsApp and Telegram (varies by type). enum: - text - image - video - audio - document - sticker - location - contact - buttons - list - cta_url - reaction - template MessageContent: type: object description: Content for non-text message types (WhatsApp and Telegram). properties: mediaUrl: type: string description: URL of the media file (for image, video, audio, document, sticker). example: https://example.com/image.jpg mediaId: type: string description: WhatsApp media ID if already uploaded. mimeType: type: string description: MIME type of the media. example: image/jpeg filename: type: string description: Filename for documents. example: invoice.pdf latitude: type: number description: Latitude for location messages. longitude: type: number description: Longitude for location messages. locationName: type: string description: Name of the location. locationAddress: type: string description: Address of the location. contacts: type: array description: Contact cards for contact messages. items: type: object properties: name: type: string phones: type: array items: type: string buttons: type: array description: Interactive buttons (max 3). maxItems: 3 items: type: object required: - id - title properties: id: type: string maxLength: 256 title: type: string maxLength: 20 listButton: type: string description: Button text for list messages. maxLength: 20 sections: type: array description: Sections for list messages. items: type: object required: - title - rows properties: title: type: string rows: type: array maxItems: 10 items: type: object required: - id - title properties: id: type: string title: type: string maxLength: 24 description: type: string maxLength: 72 ctaDisplayText: type: string description: Button label for cta_url messages. maxLength: 20 example: See Dates ctaUrl: type: string format: uri description: >- Destination URL opened in the device's default browser when the button is tapped. Used with messageType=cta_url. WhatsApp requires HTTPS in production. example: https://example.com/schedule ctaHeaderType: type: string description: Optional header type for cta_url messages. enum: - text - image - video - document ctaHeaderText: type: string description: Header text when ctaHeaderType is 'text'. maxLength: 60 ctaHeaderMediaUrl: type: string format: uri description: >- Public HTTPS URL of the header media when ctaHeaderType is 'image', 'video', or 'document'. WhatsApp fetches this URL — it must be publicly reachable and return the declared content type. footerText: type: string description: Optional footer text for cta_url messages. maxLength: 60 example: Dates subject to change. emoji: type: string description: Emoji for reaction messages. reactToMessageId: type: string description: Message ID to react to. templateId: type: string description: Template ID for template messages. templateVariables: type: object description: >- Variables for body placeholders. Keys are positions (1, 2, 3, ...) matching the order placeholders appear in the template body. additionalProperties: type: string example: '1': John '2': ORD-12345 templateButtonVariables: type: object description: >- Variables for dynamic button placeholders (URL buttons and OTP buttons). Keys are the button index (0, 1, 2) in the template's `buttons` array — not the placeholder name. Values substitute the `{{1}}` placeholder inside that button's URL. **WhatsApp constraints:** - URL buttons only accept `{{1}}` — positional, numeric, no whitespace, no name. Named placeholders like `{{token}}` are stored as literal URL text by Meta and cannot be substituted. - At most one placeholder per URL button. - A template may have at most three buttons. - Static URL buttons (no placeholder) and `quick_reply` buttons are not included here. additionalProperties: type: string example: '0': abc-report-token EmailAttachmentInput: type: object description: >- Email attachment. Provide either `content` (base64) or `path` (URL), not both. required: - filename properties: filename: type: string description: Name of the attached file. maxLength: 255 example: invoice.pdf content: type: string description: Content of the attached file as a Base64-encoded string. path: type: string format: uri description: >- URL where the attachment file is hosted. The server will fetch the file. content_type: type: string description: >- MIME type of the attachment. If not set, will be derived from the filename. example: application/pdf content_id: type: string description: >- Content ID for inline images. Reference in HTML as `