> ## 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. # Criar um modelo > Cria um modelo e o envia à Meta para aprovação. ## OpenAPI ````yaml /openapi/escrybe.pt.yaml post /api/whatsapp/v1/templates/post openapi: 3.1.0 info: title: API Escrybe version: 1.0.0 description: >- REST API da plataforma Escrybe — envie cartas físicas, cartas registradas, telegramas e e-Carta pelos Correios, dispare e-mails registrados juridicamente e envie mensagens de WhatsApp com carimbo de tempo certificado. ## Autenticação Toda conta possui um **`securityToken`** pessoal (disponível no painel em *Minhas configurações → Acesso a API*). Três produtos o utilizam de formas diferentes: | Produto | Esquema | Como | |---------|---------|------| | Cartas / Telegrama / e-Carta, E-mail Registrado, Recibos | Token de API | Envie `userSecurityToken` como parâmetro (query/body) ou `securityToken` como header | | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)` | > As rotas de **consulta** de carta e e-mail (`get`, `balance`, `download`, > `delete`) recebem o token como o primeiro segmento de **caminho** da URL — > ex.: `/api/v2/get/{securityToken}/{job_id}`. ## Envelopes de resposta A maioria dos endpoints responde com o envelope padrão `{"status": , "status_message": "...", "data": ...}` — isso cobre Cartas/Telegrama, E-mail Registrado e os endpoints de mensagens e remetentes de WhatsApp. Os endpoints de **modelos** de WhatsApp (e a sincronização de modelos) usam `{"code": , "status": "success|error", "message": "...", "data": ..., "request_id": "..."}`; o endpoint de logo usa o mesmo formato sem `request_id`. Consulte o schema de cada endpoint. Uma requisição aceita retorna HTTP `200` com o payload de sucesso; problemas de validação retornam `400`, credenciais inválidas `401` e acesso negado `403`. Métodos HTTP não suportados retornam `405`, tentativas repetidas de autenticação falhas retornam `429` e os endpoints de carta e e-mail retornam `503` durante janelas de manutenção. contact: name: Suporte Escrybe url: https://escrybe.com.br servers: - url: https://app.escrybe.com.br description: Produção - url: https://homolog.escrybe.com.br description: Homologação security: - securityTokenQuery: [] tags: - name: Letters & Telegram description: Crie e gerencie pedidos de carta, telegrama e e-Carta (Correios). - name: Account & Favorites description: Saldo da conta, contatos salvos e logo do remetente. - name: Registered E-mail description: Envie e acompanhe e-mails registrados juridicamente. - name: WhatsApp Messages description: Envie mensagens de WhatsApp e baixe atestações com carimbo de tempo. - name: WhatsApp Senders description: Gerencie números do WhatsApp Business (remetentes). - name: WhatsApp Templates description: Crie, sincronize e gerencie modelos de mensagem do WhatsApp. - name: Receipts description: Baixe recibos legais de qualquer pedido. paths: /api/whatsapp/v1/templates/post: post: tags: - WhatsApp Templates summary: Criar um modelo description: Cria um modelo e o envia à Meta para aprovação. operationId: createTemplate requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/CreateTemplateRequest' application/json: schema: $ref: '#/components/schemas/CreateTemplateRequest' responses: '200': description: >- Criado e enviado para aprovação (o campo `code` do envelope indica 201) content: application/json: schema: allOf: - $ref: '#/components/schemas/WaEnvelope' - properties: data: $ref: '#/components/schemas/TemplateCreateResult' '400': $ref: '#/components/responses/WaBadRequest' '401': $ref: '#/components/responses/WaUnauthorized' '403': $ref: '#/components/responses/WaForbidden' '404': $ref: '#/components/responses/WaNotFound' security: - basicAuth: [] components: schemas: CreateTemplateRequest: type: object required: - sender_id - name - body_text properties: sender_id: type: integer name: type: string description: > Normalizado no servidor (minúsculas, espaços viram underscores, caracteres inválidos e dígitos iniciais removidos) e prefixado com `user{id}_`. A resposta retorna o `name` final e seu texto original em `display_name`. body_text: type: string description: > Pode conter os marcadores {{1}}, {{2}}. Um rodapé de identificação do remetente é adicionado automaticamente, incluindo as variáveis reservadas {{sender_name}}, {{sender_doc}} e {{sender_phone}} (substituídas no envio). category: type: string enum: - UTILITY - MARKETING - AUTHENTICATION default: UTILITY language: type: string default: pt_BR header_text: type: string footer_text: type: string header_format: type: string enum: - NONE - TEXT - IMAGE - DOCUMENT default: NONE header_media: type: string format: binary description: >- Para cabeçalhos IMAGE/DOCUMENT. Sem mídia enviada, um arquivo de exemplo padrão da Escrybe é submetido à Meta para aprovação. header_media_base64: type: string header_media_url: type: string header_media_filename: type: string variable_examples: type: array items: type: string description: >- Exemplos para aprovação na Meta. Preenchidos a partir do seu perfil quando omitidos. WaEnvelope: type: object description: >- Envelope usado pelos endpoints de modelos de WhatsApp e pela sincronização de modelos. properties: code: type: integer example: 200 status: type: string example: success message: type: string nullable: true data: {} request_id: type: string TemplateCreateResult: type: object properties: template_id: type: integer meta_template_id: type: string name: type: string display_name: type: string status: type: string example: pending sender_id: type: integer sender_name: type: string responses: WaBadRequest: description: Requisição inválida content: application/json: schema: $ref: '#/components/schemas/WaEnvelope' example: code: 400 status: error message: Campos obrigatórios não preenchidos data: null WaUnauthorized: description: Não autorizado — credenciais inválidas content: application/json: schema: $ref: '#/components/schemas/WaEnvelope' example: code: 401 status: error message: Não autorizado — credenciais inválidas data: null WaForbidden: description: Acesso negado content: application/json: schema: $ref: '#/components/schemas/WaEnvelope' WaNotFound: description: Não encontrado content: application/json: schema: $ref: '#/components/schemas/WaEnvelope' securitySchemes: securityTokenQuery: type: apiKey in: query name: userSecurityToken description: >- Seu token de segurança, enviado como parâmetro `userSecurityToken` (query ou form). basicAuth: type: http scheme: basic description: >- HTTP Basic onde o usuário é o e-mail da conta e a senha é o token de segurança. ````