> ## Documentation Index > Fetch the complete documentation index at: https://docs.wppfy.com/llms.txt > Use this file to discover all available pages before exploring further. # Send text message > Sends a text message to a contact, group, or channel/newsletter. ## Specific Features - **Link previews** with support for automatic or custom personalization - **Basic text formatting** - **Automatic replacement of dynamic placeholders** ## Sending to a Newsletter To send text to a channel, use the same `number` field, but provide the full channel JID: - Example: `120363123456789012@newsletter` ```json { "number": "120363123456789012@newsletter", "text": "Post publicado no canal" } ``` ## Replying to a poll, list, or button Use this same endpoint to reply to an interactive message that is stored in the instance's local history. Send: - `number`: chat where the original message was received or sent; - `replyid`: ID of the original interactive message; - `text`: selection starting with `>`. The `>` marker is required to generate an interactive reply. Without it, the API only sends a text message quoting the original. ### Replying to a poll Use the option's position, starting at 1. In this public documentation, reply to only one option per request. ```json { "number": "5511999999999", "replyid": "3EB0ID_DA_ENQUETE", "text": ">1" } ``` ### Replying to a list Prefer the `rowId` configured when creating the list. The exact text of the item or its position (`>1`) is also accepted. ```json { "number": "5511999999999", "replyid": "3EB0ID_DA_LISTA", "text": ">plano_pro" } ``` ### Replying to a button Prefer the quick reply button ID. The exact displayed text or its position (`>1`) is also accepted. This applies to legacy quick buttons, templates, native flow, and carousel. URL, call, or copy buttons perform their own action and are not replied to through this flow. ```json { "number": "5511999999999", "replyid": "3EB0ID_DOS_BOTOES", "text": ">confirmar" } ``` The API returns an error when the original message is not available or the provided option does not exist. ## Common Fields This endpoint supports all **common optional fields** documented in the **"Send Message"** tag, including: `delay`, `readchat`, `readmessages`, `replyid`, `mentions`, `forward`, `track_source`, `track_id`, placeholders, and sending to groups. ## Link Previews ### Automatic Preview ```json { "number": "5511999999999", "text": "Confira: https://exemplo.com", "linkPreview": true } ``` ### Custom Preview ```json { "number": "5511999999999", "text": "Confira nosso site! https://exemplo.com", "linkPreview": true, "linkPreviewTitle": "Título Personalizado", "linkPreviewDescription": "Uma descrição personalizada do link", "linkPreviewImage": "https://exemplo.com/imagem.jpg", "linkPreviewLarge": true } ``` ## OpenAPI ````yaml /openapi-en.json post /send/text openapi: 3.1.0 info: title: WppFy - WhatsApp API version: 1.0.0 description: > API for managing WhatsApp instances and communications. ## Important Recommendation: WhatsApp Business **It is HIGHLY RECOMMENDED to use WhatsApp Business accounts** instead of regular WhatsApp for integration; regular WhatsApp may present inconsistencies, disconnections, limitations, and instability when used with our API. ## Authentication - Regular endpoints require a 'token' header with the instance token ## Instance States Instances can be in the following states: - `disconnected`: Disconnected from WhatsApp - `connecting`: Connection in progress - `connected`: Successfully connected and authenticated servers: - url: https://api.wppfy.com security: - token: [] tags: - name: Instance description: | Operations related to an instance's lifecycle, such as connecting, disconnecting, and checking status. - name: Proxy description: > WppFy uses an internal proxy by default. You can keep this default, configure your own proxy via `proxy_url`, or use your Android phone as a proxy by installing the app from https://github.com/WppFy/silver_proxy_apk (direct APK: https://github.com/WppFy/silver_proxy_apk/raw/refs/heads/main/silver_proxy.apk). If nothing is sent, we keep using the internal proxy. IPs are Brazilian; for international clients, consider a proxy in the client's region. - name: Profile description: | Operations related to the WhatsApp instance profile, such as changing the profile name and picture. - name: Business description: | ⚠️ **EXPERIMENTAL** - Endpoints not yet fully tested. Operations related to the WhatsApp Business business profile. Allows querying and updating business profile data such as description, address, email, categories, and managing the product catalog. **Requirements:** - The currently connected account must be a **WhatsApp Business** account - Personal WhatsApp accounts do not have a business profile **Note:** These endpoints may not work as expected. Report any problems found. - name: Calls description: | Operations related to WhatsApp calls. Allows making and rejecting calls programmatically. - name: Send Message description: > Endpoints for sending WhatsApp messages with different content types. ## Common Optional Fields All message sending endpoints support the following optional fields: - **`delay`** *(integer)*: Delay in milliseconds before sending - During the delay, "Typing..." or "Recording audio..." will appear depending on the type - Example: `5000` (5 seconds) - **`readchat`** *(boolean)*: Mark chat as read after sending - Removes the unread message counter from the chat - Example: `true` - **`readmessages`** *(boolean)*: Mark last received messages as read - Marks the last 10 **received** messages (not sent by you) as read - Useful to confirm reading pending messages before replying - Different from `readchat` which only removes the unread counter - Example: `true` - **`replyid`** *(string)*: ID of the message to reply to - Creates a reply linked to the original message - Support varies by message type - Example: `"3A12345678901234567890123456789012"` - **`mentions`** *(string)*: Numbers to mention (only for group sending) - Specific numbers: `"5511999999999,5511888888888"` - Mention all: `"all"` - **`forward`** *(boolean)*: Marks the message as forwarded in WhatsApp - Adds the "Forwarded" indicator to the message - Example: `true` - **`track_source`** *(string)*: Message tracking source - Identifies the system or source sending the message - Useful for integrations (e.g., "chatwoot", "crm", "chatbot") - Example: `"chatwoot"` - **`track_id`** *(string)*: ID for message tracking - Free identifier to track the message in external systems - Allows correlating messages between different platforms - **Note**: The system accepts duplicate values - there is no uniqueness validation - Use the same ID in multiple messages if it makes sense for your integration - Example: `"msg_123456789"` ### Sending to Groups - **`number`** *(string)*: To send a message to a group, use the group ID ending with `@g.us` - Example: `"120363012345678901@g.us"` - **How to get the Group ID:** - Use the `chatid` from the webhook received when someone sends a message in the group - Use the `GET /group/list` endpoint to list all groups and their IDs ## Available Placeholders All message sending endpoints support dynamic placeholders for automatic personalization: ### Name Fields - **`{{name}}`**: Consolidated chat name, using the first available option: 1. Lead name (`lead_name`) 2. Lead full name (`lead_fullName`) 3. WhatsApp contact name (`wa_contactName`) 4. WhatsApp profile name (`wa_name`) - **`{{first_name}}`**: First valid word of the consolidated name (minimum 2 characters) ### WhatsApp Fields - **`{{wa_name}}`**: WhatsApp profile name - **`{{wa_contactName}}`**: Contact name as saved in WhatsApp ### Lead Fields - **`{{lead_name}}`**: Lead name - **`{{lead_fullName}}`**: Lead full name - **`{{lead_personalid}}`**: Personal ID (SSN, CPF, CNPJ, etc) - **`{{lead_email}}`**: Lead email - **`{{lead_status}}`**: Current lead status - **`{{lead_notes}}`**: Lead notes - **`{{lead_assignedAttendant_id}}`**: ID of the assigned attendant ### Custom Fields Fields added via custom fields are accessible using `{{lead_field01}}` to `{{lead_field20}}` or use `{{fieldname}}` defined in `/instance/updateFieldsMap`. ### Usage Example ``` Hello {{name}}! I saw you work at {{company}}. Is your email {{lead_email}} correct? ``` **💡 Tip**: Use `/chat/find` to fetch chat data and see available fields before sending messages with placeholders. - name: Async Message description: > Operational controls for the internal asynchronous send queue used when a send endpoint receives `async=true`. This section is used to: - check the current state of the async queue - configure the delay between messages sent with `async=true` - clear pending backlog and cancel messages not yet completed Scope: - covers only the internal queue of async direct messages - does not change messages already sent successfully - name: Message Actions and Search - name: Chats - name: Contacts - name: Blocklist - name: Labels - name: Groups and Communities - name: Newsletters and Channels description: > Operations for reading and following WhatsApp channels (newsletters). Main use cases: - list posts already published in a channel - edit recent posts in a channel - delete recent posts in a channel - check post views and reactions - integrate channels without needing to persist messages locally Notes: - `/newsletter/messages` returns the post content - `/newsletter/messages/edit` edits the content of recent posts - `/newsletter/messages/delete` deletes recent posts - views (`viewsCount`) and reactions (`reactionCounts`) come in each post of `/newsletter/messages`, not via webhook event - `/newsletter/updates` is deprecated: WhatsApp does not respond and the API returns 504 - newsletters use their own routes and must not use `/message/edit` or `/message/delete` - name: Quick Replies description: > Management of quick replies to streamline service. **⚠️ Important**: This feature is only useful if you use a custom frontend/interface to register and use the replies. The API only stores the replies, but does not apply them automatically. ### How it works: - **Create**: Register pre-defined responses with titles and content - **List**: Retrieve all registered responses to display in your interface - **Use**: Your frontend system can use these responses to speed up typing ### Use cases: - Custom web service interfaces - Mobile apps with reply suggestions - CRM systems with message templates - Productivity tools for attendants **Not a chatbot**: For automatic responses, use Chatbot features. - name: CRM description: > Complete customer relationship management system integrated with the API. **💾 Internal Storage**: All lead data is saved directly in the API, eliminating the need for external databases. Your application can focus only on the interface and business logic. ### Available Features: - **📋 20+ customizable fields**: Name, phone, email, company, notes, etc. - **🏷️ Label System**: Organize and categorize your contacts - **🔍 Advanced Search**: Filter by any field or label - **📊 Complete History**: All interactions are registered automatically ### 🎯 Placeholders in messages: Use dynamic variables in messages for automatic personalization: ``` Hello {{name}}! I saw you work at {{company}}. Is your email {{email}} correct? Notes: {{notes}} ``` ### Typical Flow: 1. **Capture**: Leads arrive via WhatsApp or forms 2. **Enrichment**: Add data using `/chat/editLead` 3. **Segmentation**: Organize with labels 4. **Communication**: Send personalized messages with placeholders 5. **Follow-up**: History is saved automatically **Ideal for**: Sales, marketing, support, lead qualification - name: Chatwoot Integration description: > **🚧 BETA INTEGRATION - Chatwoot integration system for unified service** **⚠️ WARNING**: This integration is in BETA phase. Use at your own risk. We recommend testing in a non-production environment before use in production. This category contains resources to configure and manage integration with Chatwoot, an open-source customer service platform. The integration allows centralizing WhatsApp conversations in Chatwoot. ### Available Features: - 🔧 **Complete Configuration**: Configure URL, tokens, and Chatwoot credentials - 📬 **Bidirectional Sync**: New messages between WhatsApp and Chatwoot are synced automatically - 📱 **Contact Management**: Automatic sync of names and phones - 🔄 **LID→PN Update**: Automatic migration from Local ID to Phone Number - 🏷️ **Smart Names**: Name system with tilde (~) for automatic update - 🚫 **Group Separation**: Option to ignore groups in sync - 👤 **Message Signature**: Agent identification in sent messages - 🔗 **Automatic Webhook**: URL generated automatically to configure in Chatwoot ### 🏷️ Smart Name System: - **Names with tilde (~)**: Updated automatically when contact modifies name in WhatsApp - **Specific names**: For fixed name, remove tilde (~) from name in Chatwoot - **Example**: "~John Doe" = automatic, "John Doe" = fixed - **LID→PN Migration**: No conversation duplication during transition - **Native responses**: Appear directly in Chatwoot without external markings ### ⚠️ Known Limitations: - **History sync**: Not implemented - only new messages are synced ### Use Cases: - Centralized service in Chatwoot - Support teams with multiple agents - CRM integration via Chatwoot - Communication channel centralization - Automatic contact and name management **Ideal for**: Companies with service teams, call centers, technical support (in test environment) **Requires**: Configured Chatwoot instance, API tokens, and test environment **🚧 Remember**: BETA integration - features may change without prior notice - name: Server-Sent Events (SSE) paths: /send/text: post: tags: - Send Message summary: Send text message description: > Sends a text message to a contact, group, or channel/newsletter. ## Specific Features - **Link previews** with support for automatic or custom personalization - **Basic text formatting** - **Automatic replacement of dynamic placeholders** ## Sending to a Newsletter To send text to a channel, use the same `number` field, but provide the full channel JID: - Example: `120363123456789012@newsletter` ```json { "number": "120363123456789012@newsletter", "text": "Post publicado no canal" } ``` ## Replying to a poll, list, or button Use this same endpoint to reply to an interactive message that is stored in the instance's local history. Send: - `number`: chat where the original message was received or sent; - `replyid`: ID of the original interactive message; - `text`: selection starting with `>`. The `>` marker is required to generate an interactive reply. Without it, the API only sends a text message quoting the original. ### Replying to a poll Use the option's position, starting at 1. In this public documentation, reply to only one option per request. ```json { "number": "5511999999999", "replyid": "3EB0ID_DA_ENQUETE", "text": ">1" } ``` ### Replying to a list Prefer the `rowId` configured when creating the list. The exact text of the item or its position (`>1`) is also accepted. ```json { "number": "5511999999999", "replyid": "3EB0ID_DA_LISTA", "text": ">plano_pro" } ``` ### Replying to a button Prefer the quick reply button ID. The exact displayed text or its position (`>1`) is also accepted. This applies to legacy quick buttons, templates, native flow, and carousel. URL, call, or copy buttons perform their own action and are not replied to through this flow. ```json { "number": "5511999999999", "replyid": "3EB0ID_DOS_BOTOES", "text": ">confirmar" } ``` The API returns an error when the original message is not available or the provided option does not exist. ## Common Fields This endpoint supports all **common optional fields** documented in the **"Send Message"** tag, including: `delay`, `readchat`, `readmessages`, `replyid`, `mentions`, `forward`, `track_source`, `track_id`, placeholders, and sending to groups. ## Link Previews ### Automatic Preview ```json { "number": "5511999999999", "text": "Confira: https://exemplo.com", "linkPreview": true } ``` ### Custom Preview ```json { "number": "5511999999999", "text": "Confira nosso site! https://exemplo.com", "linkPreview": true, "linkPreviewTitle": "Título Personalizado", "linkPreviewDescription": "Uma descrição personalizada do link", "linkPreviewImage": "https://exemplo.com/imagem.jpg", "linkPreviewLarge": true } ``` requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: >- ID of the chat the message will be sent to. Can be a phone number in international format, a group ID (`@g.us`), a user ID (with `@s.whatsapp.net` or `@lid`) or a channel/newsletter ID (`@newsletter`). example: '5511999999999' text: type: string description: >- Message text. To reply to a poll, list, or button, use a selection starting with `>` together with `replyid`. Accepts placeholders in regular text messages. example: Hello {{name}}! How can I help? linkPreview: type: boolean description: > Enables/disables link previews. If true, automatically looks for a link in the text to generate a preview. Behavior: - If only linkPreview=true: generates an automatic preview of the first link found in the text - If custom fields are provided (title, description, image): uses the provided values - If custom fields are partial: combines them with automatic link data as fallback - Title or description containing only whitespace: the preview is generated without that field, without fetching from the link example: true linkPreviewTitle: type: string description: >- Sets a custom title for the link preview. Empty uses the link's title; with only a space (`" "`), the preview has no title. example: Custom Title linkPreviewDescription: type: string description: >- Sets a custom description for the link preview. Empty uses the link's description; with only a space (`" "`), the preview has no description. example: Custom link description linkPreviewImage: type: string description: URL or Base64 of the image to use in the link preview example: https://exemplo.com/imagem.jpg linkPreviewLarge: type: boolean description: >- If true, generates a large preview with image upload. If false, generates a small preview without upload example: true replyid: type: string description: >- Original message ID. With `text` starting with `>`, generates the native poll, list or button reply when the original type is supported. example: 3EB0538DA65A59F6D8A251 mentions: type: string description: Numbers to mention (comma separated) example: 5511999999999,5511888888888 readchat: type: boolean description: Marks chat as read after sending example: true readmessages: type: boolean description: Marks latest received messages as read example: true delay: type: integer description: >- Delay in milliseconds before sending; during delay 'Typing...' will appear example: 1000 forward: type: boolean description: Marks the message as forwarded on WhatsApp example: true track_source: type: string description: Message tracking source example: chatwoot track_id: type: string description: ID for message tracking (accepts duplicate values) example: msg_123456789 async: type: boolean description: >- If true, sends the message asynchronously via the internal queue. Useful for high message volume. example: false required: - number - text examples: basic: summary: Basic message description: Simplest possible example value: number: '5511999999999' text: Olá! Como posso ajudar? withLinkPreview: summary: With automatic preview description: Automatic link preview in text value: number: '5511999999999' text: 'Confira: https://exemplo.com' linkPreview: true customLinkPreview: summary: Custom preview description: Preview with custom title, description, and image value: number: '5511999999999' text: Confira nosso site! https://exemplo.com linkPreview: true linkPreviewTitle: Título Personalizado linkPreviewDescription: Uma descrição personalizada do link linkPreviewImage: https://exemplo.com/imagem.jpg linkPreviewLarge: true withPlaceholders: summary: With placeholders description: Text with native placeholders and a custom field value: number: '5511999999999' text: >- Olá {{first_name}}! Empresa: {{lead_field01}}. Seu email {{lead_email}} está correto? newsletter: summary: Sending to newsletter description: >- Publishes a text message to a channel using the full `@newsletter` JID. value: number: 120363123456789012@newsletter text: Post publicado no canal pollReply: summary: Reply to poll description: Selects option 1 of the poll identified by replyid. value: number: '5511999999999' replyid: 3EB0ID_DA_ENQUETE text: '>1' listReply: summary: Reply to list description: Selects by the rowId configured in the list item. value: number: '5511999999999' replyid: 3EB0ID_DA_LISTA text: '>plano_pro' buttonReply: summary: Reply to button description: Selects by the ID configured in the quick reply button. value: number: '5511999999999' replyid: 3EB0ID_DOS_BOTOES text: '>confirmar' responses: '200': description: Message sent successfully content: application/json: schema: allOf: - $ref: '#/components/schemas/Message' - type: object properties: response: type: object properties: status: type: string example: success message: type: string example: Message sent successfully '400': description: Invalid request content: application/json: schema: type: object properties: error: type: string example: Missing number or text '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: Invalid token '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: type: string example: Rate limit exceeded '500': description: Internal server error content: application/json: schema: type: object properties: error: type: string example: >- WhatsApp server error 463: WhatsApp reported that the currently connected account is under a temporary restriction for starting new conversations, usually related to sending volume or quality. error_source: type: string example: whatsapp_server provider: type: string example: whatsapp provider_code: type: integer example: 463 error_key: type: string example: WHATSAPP_REACHOUT_TIMELOCK message: type: string example: >- The WhatsApp server rejected this message. This was not an internal API error. message_ptbr: type: string example: >- The WhatsApp server rejected this message. This was not an internal API error. provider_message: type: string example: >- WhatsApp reported that the currently connected account is under a temporary restriction for starting new conversations, usually related to sending volume or quality. provider_message_ptbr: type: string example: >- WhatsApp reported that the currently connected account is under a temporary restriction on starting new conversations, usually related to sending volume or quality. diagnostics_endpoint: type: string example: /instance/wa_messages_limits details: type: object properties: new_chat_message_capping: type: object additionalProperties: true reachout_timelock: type: object additionalProperties: true examples: generic: summary: Generic internal error value: error: Failed to send message whatsapp_463: summary: WhatsApp error when starting new conversations value: error: >- WhatsApp server error 463: WhatsApp reported that the currently connected account is under a temporary restriction for starting new conversations, usually related to sending volume or quality. error_source: whatsapp_server provider: whatsapp provider_code: 463 error_key: WHATSAPP_REACHOUT_TIMELOCK message: >- The WhatsApp server rejected this message. This was not an internal API error. message_ptbr: >- O servidor do WhatsApp recusou esta mensagem. Isso não foi um erro interno da API. provider_message: >- WhatsApp reported that the currently connected account is under a temporary restriction for starting new conversations, usually related to sending volume or quality. provider_message_ptbr: >- O WhatsApp informou que a conta atualmente conectada está sob uma restrição temporária para iniciar novas conversas, normalmente relacionada a volume ou qualidade de envios. diagnostics_endpoint: /instance/wa_messages_limits details: new_chat_message_capping: available: true status: CAPPED used_quota: 10 total_quota: 10 reachout_timelock: available: true active: true until: '2026-04-07T12:00:00Z' enforcement_type: BIZ_QUALITY components: schemas: Message: type: object description: Represents a message exchanged in the system properties: id: type: string format: uuid description: Internal unique message ID (format r + 7 random hex characters) messageid: type: string description: Original message ID at the provider chatid: type: string description: Related conversation ID sender: type: string description: Message sender ID senderName: type: string description: Sender's display name isGroup: type: boolean description: Indicates whether it is a group message default: false fromMe: type: boolean description: Indicates whether the message was sent by the user default: false messageType: type: string description: Message content type source: type: string description: Message source platform messageTimestamp: type: integer description: Original message timestamp in milliseconds default: 0 status: type: string description: > Message lifecycle status. Common examples: `Queued`, `Canceled`, `Failed`, `Sent`, `Delivered`, `Read`. In group messages, it follows the most advanced participant: `Delivered` when at least one received it, `Read` when at least one read it, and `Played` when at least one listened to it. text: type: string description: Original message text default: '' quoted: type: string description: ID of the quoted/replied message default: '' edited: type: string description: Message edit history default: '' reaction: type: string description: ID of the reacted message default: '' vote: type: string description: Poll and list voting data default: '' convertOptions: type: string description: Conversion of message options, list, poll and buttons default: '' buttonOrListid: type: string description: ID of the selected button or list item default: '' owner: type: string description: Message owner default: '' error: type: string description: Error message if sending failed default: '' content: description: Raw message content (serialized JSON or text) oneOf: - type: object additionalProperties: true - type: string description: Raw text when not JSON wasSentByApi: type: boolean description: Indicates whether the message was sent via API pinned: type: boolean description: >- Message pinned in the conversation (pin and unpin also arrive in `messages_update`, types `Pinned` and `Unpinned`) sendFunction: type: string description: Function used to send the message (when sent via API) sendPayload: description: >- Payload used in the send when available. Base64 media data is omitted. oneOf: - type: object additionalProperties: true - type: string description: Raw text when not JSON fileURL: type: string description: Message file URL or reference callPeer: type: object description: >- Known contact associated with a call, when available in `messageType: call`. properties: jid: type: string name: type: string imagePreviewUrl: type: string send_folder_id: type: string description: Folder associated with the send (when applicable) track_source: type: string description: Tracking source track_id: type: string description: Tracking ID (may repeat) ai_metadata: type: object description: >- Record of an AI round. The full one (request to the model, response, and `outcome`) is stored once, on the contact's last message that the round replied to, even when nothing went out (error, discarded response). Each message sent by the AI carries only `agent_id` and `turn` (the `id` of that contact message). properties: agent_id: type: string description: ID of the responsible AI agent turn: type: string description: >- In the message sent by the AI: the `id` of the contact's message where the full record of the round is stored. flow_id: type: string description: >- Message sent by a flow: the flow's `id`. A message sent by the AI includes the `agent_id`. request: type: object description: Request data for the AI API properties: messages: type: array description: History of messages sent to the API tools: type: array description: Tools available to the agent options: type: object description: API configuration options properties: model: type: string temperature: type: number maxTokens: type: integer topP: type: number frequencyPenalty: type: number presencePenalty: type: number response: type: object description: AI API response properties: choices: type: array description: Results returned by the API toolResults: type: array description: Tool execution results error: type: string description: Error message, if any outcome: type: object description: What the round actually did (only in the full record). properties: status: type: string enum: - sent - cancelled - error - empty description: >- `sent`: something was sent; `cancelled`: discarded (the conversation was paused, a flow started, or the hourly reply limit was reached); `error`: the provider failed; `empty`: nothing to send. texts: type: integer description: Text messages sent. audio: type: boolean description: Replied with audio. menus: type: integer description: Menus sent. files: type: integer description: Files (registered messages) sent. handoff: type: string description: '`chamar_humano`: the summary for whoever takes over.' lead: type: array items: type: string description: >- `atualizar_lead`: what was written to the CRM (`lead_email = ana@exemplo.com; column = Agendado`). detail: type: string description: Why it was discarded, or the error. sender_pn: description: Sender's resolved PN JID (when available) oneOf: - type: string - type: 'null' sender_lid: description: Sender's original LID (when available) oneOf: - type: string - type: 'null' sender_image_preview_url: type: string format: uri description: >- Temporary preview URL of the sender, when known. Hydration in this version fills in messages received in groups; the field may be omitted. It does not trigger a photo query to WhatsApp during listing. securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.