> ## 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.

# Update a template



## OpenAPI

````yaml /openapi/escrybe.en.yaml put /api/whatsapp/v1/templates/put
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": <http code>,
    "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": <http
    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/templates/put:
    put:
      tags:
        - WhatsApp Templates
      summary: Update a template
      operationId: updateTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateTemplateRequest'
      responses:
        '200':
          description: Updated — the template is resubmitted to Meta and returns to pending
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/WaEnvelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          template_id:
                            type: integer
                          name:
                            type: string
                          new_status:
                            type: string
                            example: pending
        '400':
          $ref: '#/components/responses/WaBadRequest'
        '401':
          $ref: '#/components/responses/WaUnauthorized'
        '403':
          $ref: '#/components/responses/WaForbidden'
        '404':
          $ref: '#/components/responses/WaNotFound'
      security:
        - basicAuth: []
components:
  schemas:
    UpdateTemplateRequest:
      type: object
      required:
        - template_id
      properties:
        template_id:
          type: integer
        body_text:
          type: string
        header_text:
          type: string
        footer_text:
          type: string
        variable_examples:
          type: array
          items:
            type: string
        header_media:
          type: string
          format: binary
          description: >-
            Replacement sample media for IMAGE/DOCUMENT headers (multipart
            only).
    WaEnvelope:
      type: object
      description: Envelope used by the WhatsApp template endpoints and template sync.
      properties:
        code:
          type: integer
          example: 200
        status:
          type: string
          example: success
        message:
          type: string
          nullable: true
        data: {}
        request_id:
          type: string
  responses:
    WaBadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WaEnvelope'
          example:
            code: 400
            status: error
            message: Campos obrigatórios não preenchidos
            data: null
    WaUnauthorized:
      description: Unauthorized — invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WaEnvelope'
          example:
            code: 401
            status: error
            message: Não autorizado — credenciais inválidas
            data: null
    WaForbidden:
      description: Access denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WaEnvelope'
    WaNotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WaEnvelope'
  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.

````