Hellou AI WhatsApp Templates API

openapi: 3.2.0
info:
  title: HellouOne WhatsApp Templates API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:
- name: WhatsApp Templates
paths:
  /api/v1/accounts/{account_id}/inboxes/{id}/message_templates:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - name: id
      in: path
      required: true
      description: ID of the WhatsApp inbox
      schema:
        type: integer
    get:
      tags:
      - WhatsApp Templates
      operationId: listWhatsappMessageTemplates
      summary: List message templates
      description: 'Returns the message templates of a WhatsApp inbox, as stored at the last

        successful sync with WhatsApp. Templates are not fetched live: call

        **Sync message templates** to refresh them. Every language of a template is

        a separate entry.


        Available to administrators and to agents who can access the inbox.


        **Requires feature:** `whatsapp_templates`'
      x-required-feature: whatsapp_templates
      parameters:
      - name: name
        in: query
        required: false
        description: Return only templates with exactly this name (all languages).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    type: array
                    description: Empty when the inbox has never synced or no template matches `name`.
                    items:
                      $ref: '#/components/schemas/whatsapp_message_template'
                  meta:
                    type: object
                    properties:
                      last_sync_attempt_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: 'When a sync was last attempted, successful or not. A sync that

                          failed still moves this forward without changing the templates.

                          '
                    required:
                    - last_sync_attempt_at
                required:
                - payload
                - meta
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '422':
          description: The inbox is not a WhatsApp inbox.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
  /api/v1/accounts/{account_id}/inboxes/{id}/sync_templates:
    parameters:
    - $ref: '#/components/parameters/account_id'
    - name: id
      in: path
      required: true
      description: ID of the WhatsApp inbox
      schema:
        type: integer
    post:
      tags:
      - WhatsApp Templates
      operationId: syncWhatsappMessageTemplates
      summary: Sync message templates
      description: 'Queues a background refresh of the inbox''s templates from WhatsApp and

        returns at once. Poll **List message templates** and compare

        `meta.last_sync_attempt_at` to see when it has run. If WhatsApp answers

        with an error, the stored templates are kept unchanged.


        **Administrators only.**


        **Requires feature:** `whatsapp_templates`'
      x-required-feature: whatsapp_templates
      responses:
        '200':
          description: Sync queued.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Template sync initiated successfully
                required:
                - message
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '422':
          description: The inbox is not a WhatsApp inbox.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '500':
          description: The sync could not be queued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
components:
  responses:
    unauthorized:
      description: Missing or invalid `api_access_token`, or a bot token on an endpoint bots cannot use.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
    forbidden:
      description: 'Not allowed: the user''s role does not permit it, the feature is not enabled

        for the account (`reason: feature_disabled`), or the account is read-only.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
    not_found:
      description: The resource does not exist in this account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_message'
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
  schemas:
    whatsapp_message_template:
      type: object
      description: 'A WhatsApp message template as WhatsApp (Meta) returned it at the last

        successful sync. The object is passed through unchanged, so it carries every

        field Meta includes; the ones below are the ones you can rely on.

        '
      additionalProperties: true
      properties:
        id:
          type: string
          description: Meta's ID for the template.
        name:
          type: string
          description: Template name. The same name can appear once per language.
        language:
          type: string
          description: Language code of this translation, for example `en_US` or `es`.
        status:
          type: string
          description: Review status at Meta, for example `APPROVED`, `PENDING`, `REJECTED` or `PAUSED`.
        category:
          type: string
          description: Template category, for example `MARKETING`, `UTILITY` or `AUTHENTICATION`.
        parameter_format:
          type: string
          description: '`POSITIONAL` (`{{1}}`) or `NAMED` (`{{customer_name}}`) placeholders.'
        components:
          type: array
          description: Header, body, footer and buttons of the template.
          items:
            type: object
            additionalProperties: true
            properties:
              type:
                type: string
                description: '`HEADER`, `BODY`, `FOOTER` or `BUTTONS`.'
              format:
                type: string
                description: For a header, `TEXT`, `IMAGE`, `VIDEO`, `DOCUMENT` or `LOCATION`.
              text:
                type: string
                description: Component text, with `{{...}}` placeholders.
              buttons:
                type: array
                description: For a `BUTTONS` component, the buttons it holds.
                items:
                  type: object
                  additionalProperties: true
    error_message:
      type: object
      description: An error with a human-readable message.
      properties:
        error:
          type: string
          description: What went wrong.
        reason:
          type: string
          description: Machine-readable cause, when there is one (for example `feature_disabled`).
      required:
      - error
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A user''s access token, from **Profile settings → Access token** in the dashboard.

        Requests act with that user''s role: administrators reach everything in their

        account, agents only what their role and visibility settings allow.

        '
    agentBotApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'An agent bot''s access token, shown to administrators on the bot''s settings page.

        Bot tokens reach a limited set of conversation and message endpoints.

        '
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A platform app token, issued by the installation operator. Used to provision

        accounts, users, account memberships and agent bots.

        '
    connectorInvokeToken:
      type: http
      scheme: bearer
      description: 'A connector''s invoke token (`hci_…`), sent as `Authorization: Bearer <token>`.

        Each connector install has its own; it is rotated whenever the connector is

        reconnected or disconnected, so a stale copy stops working.

        '
x-tagGroups:
- name: Guides
  tags:
  - Introduction
  - Authentication
  - Errors
  - Pagination
  - Rate limits
  - Webhook events
- name: Webhook payloads
  tags:
  - Event payloads
- name: Platform
  tags:
  - Accounts
  - Account Users
  - AgentBots
  - Users
- name: Application
  tags:
  - Account AgentBots
  - Agents
  - Automation Rule
  - Campaigns
  - Canned Responses
  - Contacts
  - Contact Labels
  - Conversation Assignment
  - Conversation Labels
  - Conversations
  - Custom Attributes
  - Custom Filters
  - Help Center
  - Inboxes
  - Integrations
  - Macros
  - Messages
  - Profile
  - Reports
  - Security Settings
  - Teams
  - Webhooks
- name: Business tools
  tags:
  - AI Classifications
  - Assignment Settings
  - Calls
  - AI Phone Lines
  - Connectors
  - ElevenLabs Integration
  - Facebook Marketing
  - HellouAI Integration
  - Knowledge Base
  - Marketing Consent
  - Plan Upgrades
  - Voice Campaigns
  - WhatsApp Campaigns
  - WhatsApp Flows
  - WhatsApp Templates
- name: Client
  tags:
  - Inbox API
  - Contacts API
  - Conversations API
  - Messages API
- name: Others
  tags:
  - CSAT Survey Page