# Escrybe API ## Docs - [Check whether a number is on WhatsApp](https://docs.escrybe.com.br/api-reference/account-&-favorites/check-whether-a-number-is-on-whatsapp.md) - [Create a saved contact](https://docs.escrybe.com.br/api-reference/account-&-favorites/create-a-saved-contact.md) - [Delete a saved contact](https://docs.escrybe.com.br/api-reference/account-&-favorites/delete-a-saved-contact.md) - [Get account balance](https://docs.escrybe.com.br/api-reference/account-&-favorites/get-account-balance.md) - [Get sender logo](https://docs.escrybe.com.br/api-reference/account-&-favorites/get-sender-logo.md) - [List saved contacts](https://docs.escrybe.com.br/api-reference/account-&-favorites/list-saved-contacts.md) - [Update a saved contact](https://docs.escrybe.com.br/api-reference/account-&-favorites/update-a-saved-contact.md) - [Upload or remove sender logo](https://docs.escrybe.com.br/api-reference/account-&-favorites/upload-or-remove-sender-logo.md) - [Cancel an order](https://docs.escrybe.com.br/api-reference/letters-&-telegram/cancel-an-order.md) - [Create an order](https://docs.escrybe.com.br/api-reference/letters-&-telegram/create-an-order.md): Creates a letter, registered letter, telegram, mala direta, Sedex or e-Carta order. The required fields depend on `shipType`. PDF documents may be sent as base64, a URL or a multipart file upload. - [Download an order file](https://docs.escrybe.com.br/api-reference/letters-&-telegram/download-an-order-file.md): Returns the requested file as base64 inside the JSON envelope. - [Get an order](https://docs.escrybe.com.br/api-reference/letters-&-telegram/get-an-order.md) - [Download an order receipt](https://docs.escrybe.com.br/api-reference/receipts/download-an-order-receipt.md): Returns the legal receipt as a PDF (or HTML when `format=html`). Error responses use the standard JSON envelope `{status, status_message, data}`. - [Get a registered e-mail status](https://docs.escrybe.com.br/api-reference/registered-e-mail/get-a-registered-e-mail-status.md) - [Send a registered e-mail](https://docs.escrybe.com.br/api-reference/registered-e-mail/send-a-registered-e-mail.md) - [Cancel a WhatsApp message](https://docs.escrybe.com.br/api-reference/whatsapp-messages/cancel-a-whatsapp-message.md): Provide either `outbox_id` or `message_id`. Messages can be cancelled while awaiting payment or queued (outbox status pending/processing, or message status 0/2). Credit refunds are issued only when an admin cancels a failed message paid with escrybe_credits. - [Download certified-timestamp attestation bundle](https://docs.escrybe.com.br/api-reference/whatsapp-messages/download-certified-timestamp-attestation-bundle.md): Returns a ZIP with the certified-timestamp attestation files (payload, SHA-256, RFC 3161 `.tsr` token and manifest) for each phase of a message. Provide either `message_id` or the public `code` (visual id). - [List or fetch WhatsApp messages](https://docs.escrybe.com.br/api-reference/whatsapp-messages/list-or-fetch-whatsapp-messages.md) - [Reprocess a message after adding credits](https://docs.escrybe.com.br/api-reference/whatsapp-messages/reprocess-a-message-after-adding-credits.md): Re-queues one of your messages stuck with status 2 (insufficient credits) after you top up your balance. Only credit-paid (escrybe_credits) messages can be reprocessed. Messages already queued or being processed return `result: no_change`. - [Send a WhatsApp message](https://docs.escrybe.com.br/api-reference/whatsapp-messages/send-a-whatsapp-message.md): 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. - [Change sender status](https://docs.escrybe.com.br/api-reference/whatsapp-senders/change-sender-status.md) - [Create or update a sender](https://docs.escrybe.com.br/api-reference/whatsapp-senders/create-or-update-a-sender.md): Omit `id` (or set 0) to create; provide `id` to update. - [List senders](https://docs.escrybe.com.br/api-reference/whatsapp-senders/list-senders.md): Team guests also see their team owner's senders. - [Sync templates from Meta](https://docs.escrybe.com.br/api-reference/whatsapp-senders/sync-templates-from-meta.md) - [Create a template](https://docs.escrybe.com.br/api-reference/whatsapp-templates/create-a-template.md): Creates a template and submits it to Meta for approval. - [Delete a template](https://docs.escrybe.com.br/api-reference/whatsapp-templates/delete-a-template.md) - [List templates](https://docs.escrybe.com.br/api-reference/whatsapp-templates/list-templates.md) - [Update a template](https://docs.escrybe.com.br/api-reference/whatsapp-templates/update-a-template.md) - [Authentication](https://docs.escrybe.com.br/en/authentication.md): Every request is authenticated with your account security token. - [Errors & Response Envelopes](https://docs.escrybe.com.br/en/errors.md): How responses and errors are shaped across the API. - [Introduction](https://docs.escrybe.com.br/en/introduction.md): Send letters, telegrams, e-Carta, registered e-mails and WhatsApp messages through one API. - [Registered E-mail](https://docs.escrybe.com.br/en/products/email.md): Send legally registered e-mails and track delivery and opens. - [Letters & Telegram](https://docs.escrybe.com.br/en/products/letters.md): Create and track Correios orders: letters, AR, telegrams, mala direta, Sedex and e-Carta. - [Receipts](https://docs.escrybe.com.br/en/products/receipts.md): Download a legal receipt PDF for any order. - [WhatsApp](https://docs.escrybe.com.br/en/products/whatsapp.md): Send template messages with certified timestamps, managing senders and templates. - [Quickstart](https://docs.escrybe.com.br/en/quickstart.md): Send your first registered letter in a few minutes. ## OpenAPI Specs - [escrybe.pt](https://docs.escrybe.com.br/openapi/escrybe.pt.yaml) - [escrybe.en](https://docs.escrybe.com.br/openapi/escrybe.en.yaml)