> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bevits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar plantillas de mensaje

> Lista las plantillas de WhatsApp (oficial y no oficial), email y SMS que un flow puede enviar, con vista previa del texto, estado de aprobación de WhatsApp y el dato del cliente que muestra cada variable. Usa el id como template_id al crear el flow.



## OpenAPI

````yaml /openapi.es.json get /v1/message-templates
openapi: 3.1.0
info:
  title: API de Bevits
  version: 1.0.0
  description: >-
    API pública para consultar datos de CRM, compras y automatización de una
    organización de Bevits y crear automatizaciones como borrador para
    revisarlas y activarlas.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Producción
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidad de la API.
  - name: Identidad
    description: Identidad de la organización y de la clave API.
  - name: Clientes
    description: Clientes y sus relaciones.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas desde las integraciones.
  - name: Datos del CRM
    description: Etiquetas y definiciones de atributos.
  - name: Automatizaciones
    description: Flows de automatización.
  - name: Campañas
    description: Campañas de email.
paths:
  /v1/message-templates:
    get:
      tags:
        - Automatizaciones
      summary: Listar plantillas de mensaje
      description: >-
        Lista las plantillas de WhatsApp (oficial y no oficial), email y SMS que
        un flow puede enviar, con vista previa del texto, estado de aprobación
        de WhatsApp y el dato del cliente que muestra cada variable. Usa el id
        como template_id al crear el flow.
      operationId: listMessageTemplates
      parameters:
        - $ref: '#/components/parameters/MessageTemplateChannel'
      responses:
        '200':
          $ref: '#/components/responses/MessageTemplateList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    MessageTemplateChannel:
      name: channel
      in: query
      description: Filtra las plantillas por canal.
      schema:
        type: string
        enum:
          - whatsapp
          - whatsapp_unofficial
          - email
          - sms
  responses:
    MessageTemplateList:
      description: Plantillas de mensaje disponibles para flows.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageTemplateList'
    Unauthorized:
      description: Clave API ausente, inválida, expirada o revocada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: Un parámetro no superó la validación.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Límite de solicitudes superado.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Error inesperado en el servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    MessageTemplateList:
      type: object
      required:
        - object
        - data
        - has_more
      properties:
        object:
          type: string
          const: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/MessageTemplate'
        has_more:
          type: boolean
          const: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos antes de volver a intentarlo.
    MessageTemplate:
      type: object
      required:
        - object
        - id
        - channel
        - name
        - variables
      properties:
        object:
          type: string
          const: message_template
        id:
          type: string
          pattern: ^(wtp|etp|stp)_[A-Za-z0-9_-]+$
          description: >-
            Úsalo como template_id al crear el flow: wtp_ para WhatsApp, etp_
            para email y stp_ para SMS.
        channel:
          type: string
          enum:
            - whatsapp
            - whatsapp_unofficial
            - email
            - sms
        name:
          type: string
        status:
          type: string
          description: >-
            Estado de aprobación de WhatsApp: approved, pending, rejected, draft
            o paused.
        preview:
          type: string
          description: Inicio del texto de la plantilla.
        variables:
          type: array
          description: >-
            Variables de la plantilla y el dato del cliente que muestra cada
            una.
          items:
            type: object
            required:
              - placeholder
              - source
            properties:
              placeholder:
                type: string
                example: '{{1}}'
              source:
                type: string
                example: first_name
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        message:
          type: string
        param:
          type: string
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Segundos antes de volver a intentarlo.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Límite total de la ventana actual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Solicitudes restantes en la ventana actual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC en que termina la ventana actual.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: Clave API creada en la configuración de la organización.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.