> ## Documentation Index > Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Send a WhatsApp message > The recipient's phone is normalized to E.164 and verified to be a WhatsApp number — requests for numbers not on WhatsApp are rejected with 400. ## OpenAPI ````yaml /openapi/escrybe.en.yaml post /api/whatsapp/v1/post openapi: 3.1.0 info: title: Escrybe API version: 1.0.0 description: > REST API for the Escrybe platform — send physical letters, registered letters, telegrams and e-Carta through Brazilian Correios, dispatch legally registered e-mails, and send WhatsApp messages with certified timestamps. ## Authentication Every account has a personal **`securityToken`** (find it in the panel under *Account → API*). Three products use it differently: | Product | Scheme | How | |---------|--------|-----| | Letters / Telegram / e-Carta, Registered E-mail, Receipts | API token | Send `userSecurityToken` as a query/body parameter, or `securityToken` as a header | | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)` | > The letter and e-mail **read** routes (`get`, `balance`, `download`, > `delete`) take the token as the first URL **path** segment — e.g. > `/api/v2/get/{securityToken}/{job_id}`. ## Response envelopes Most endpoints reply with the standard envelope `{"status": , "status_message": "...", "data": ...}` — this covers Letters/Telegram, Registered E-mail, and the WhatsApp message and sender endpoints. The WhatsApp **template** endpoints (and template sync) use `{"code": , "status": "success|error", "message": "...", "data": ..., "request_id": "..."}`; the logo endpoint uses the same shape without `request_id`. See the schema of each endpoint. A request that is accepted returns an HTTP `200` with a success payload; validation problems return `400`, bad credentials `401`, and forbidden access `403`. Unsupported HTTP methods return `405`, repeated failed authentication attempts return `429`, and the letter and e-mail endpoints return `503` during maintenance windows. contact: name: Escrybe Support url: https://escrybe.com.br servers: - url: https://app.escrybe.com.br description: Production - url: https://homolog.escrybe.com.br description: Staging security: - securityTokenQuery: [] tags: - name: Letters & Telegram description: Create and manage letter, telegram and e-Carta orders (Correios). - name: Account & Favorites description: Account balance, saved contacts and sender logo. - name: Registered E-mail description: Send and track legally registered e-mails. - name: WhatsApp Messages description: Send WhatsApp messages and download certified-timestamp attestations. - name: WhatsApp Senders description: Manage WhatsApp Business numbers (senders). - name: WhatsApp Templates description: Create, sync and manage WhatsApp message templates. - name: Receipts description: Download legal receipts for any order. paths: /api/whatsapp/v1/post: post: tags: - WhatsApp Messages summary: Send a WhatsApp message description: > The recipient's phone is normalized to E.164 and verified to be a WhatsApp number — requests for numbers not on WhatsApp are rejected with 400. operationId: sendWhatsappMessage requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendWhatsappRequest' multipart/form-data: schema: $ref: '#/components/schemas/SendWhatsappRequest' responses: '200': description: Message created and awaiting payment content: application/json: schema: allOf: - $ref: '#/components/schemas/WaMessagesEnvelope' - properties: data: $ref: '#/components/schemas/WhatsappCreateResult' '400': $ref: '#/components/responses/WaMsgBadRequest' '401': $ref: '#/components/responses/WaMsgUnauthorized' '403': $ref: '#/components/responses/WaMsgForbidden' '500': $ref: '#/components/responses/WaMsgServerError' security: - basicAuth: [] components: schemas: SendWhatsappRequest: type: object required: - sender_name - sender_document - recipient_name - recipient_phone - recipient_document - template_id - paymentMethod properties: sender_name: type: string sender_document: type: string description: Sender CPF/CNPJ. recipient_name: type: string recipient_phone: type: string description: Normalized to E.164. recipient_document: type: string template_id: type: integer description: > Must be an approved template belonging to the selected sender. With system senders, the template must have been created by you (or your team owner) or be shared. paymentMethod: type: string enum: - escrybe_credits - invoice - team team_member_id: type: integer description: Required when paymentMethod=team. body: type: string maxLength: 4096 template_variables: type: object description: >- Map of template variable substitutions. Must cover at least the template's variable count. media_url: type: string description: >- One of media_url/media_file/media_base64 is required when the template header format is IMAGE or DOCUMENT. media_filename: type: string media_file: type: string format: binary description: >- IMAGE JPEG/PNG ≤5MB; DOCUMENT PDF ≤100MB. Password-protected PDFs are rejected. media_base64: type: string sender_choice: type: string default: system description: '`system` or explicit sender.' sender_id: type: integer description: Specific sender to use. WaMessagesEnvelope: type: object description: > Standard envelope used by the WhatsApp message and sender endpoints (same shape as the letters and e-mail envelopes). properties: status: type: integer example: 200 status_message: type: string data: oneOf: - type: object - type: string - type: 'null' WhatsappCreateResult: type: object properties: message_id: type: integer visual_id: type: string status: type: string example: processing paymentMethod: type: string stored_payment_method: type: string description: Payment method actually stored (team billing is stored as invoice). team_member_id: type: integer nullable: true template_id: type: integer template_name: type: string sender_id: type: integer responses: WaMsgBadRequest: description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' example: status: 400 status_message: Campos obrigatórios não preenchidos data: null WaMsgUnauthorized: description: Unauthorized — invalid credentials content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' example: status: 401 status_message: Unauthorized - invalid credentials data: null WaMsgForbidden: description: Access denied content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' WaMsgServerError: description: Internal error content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' securitySchemes: securityTokenQuery: type: apiKey in: query name: userSecurityToken description: >- Your account security token, sent as the `userSecurityToken` query or form parameter. basicAuth: type: http scheme: basic description: >- HTTP Basic where username is your account e-mail and password is your security token. ````