WhatsApp

WhatsApp Templates API

The Templates API from WhatsApp — 2 operation(s) for templates.

GitHub OpenAPI

Operations 4

GET /{Version}/{TEMPLATE_ID} Get template by ID (default fields) #
POST /{Version}/{TEMPLATE_ID} Edit template #
GET /{Version}/{WABA-ID}/message_templates Get template by name (default fields) #
DELETE /{Version}/{WABA-ID}/message_templates Delete template by name #

Documentation

📖
Documentation
https://developers.facebook.com/documentation/business-messaging/whatsapp/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/whatsapp/openapi/whatsapp-templates-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/meta/openapi

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-profile-node-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-phone-number-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-permission-check-response-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-account-number-schema.json

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/WhatsApp/WhatsApp-Flows-Tools/main/postman/v1/whatsapp-cloud-api.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/whatsapp:whatsapp-templates-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whatsapp-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: Templates
paths:
  /{Version}/{TEMPLATE_ID}:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    - $ref: '#/components/parameters/Authorization'
    - name: Version
      in: path
      required: true
      schema:
        type: string
    - name: TEMPLATE_ID
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Templates
      summary: Get template by ID (default fields)
      description: '- Guide: Message Templates

        - Guide: How To Monitor Quality Signals

        - Endpoint reference: WhatsApp Message Template'
      operationId: getTemplateByIdDefaultFields
      responses:
        '200':
          description: Example response
          headers:
            Access-Control-Allow-Origin:
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            Alt-Svc:
              $ref: '#/components/headers/Alt-Svc'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            Connection:
              $ref: '#/components/headers/Connection'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Date:
              $ref: '#/components/headers/Date'
            ETag:
              $ref: '#/components/headers/ETag'
            Expires:
              $ref: '#/components/headers/Expires'
            Pragma:
              $ref: '#/components/headers/Pragma'
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            Vary:
              $ref: '#/components/headers/Vary'
            X-FB-Debug:
              $ref: '#/components/headers/X-FB-Debug'
            facebook-api-version:
              $ref: '#/components/headers/facebook-api-version'
            x-business-use-case-usage:
              $ref: '#/components/headers/x-business-use-case-usage'
            x-fb-request-id:
              $ref: '#/components/headers/x-fb-request-id'
            x-fb-rev:
              $ref: '#/components/headers/x-fb-rev'
            x-fb-trace-id:
              $ref: '#/components/headers/x-fb-trace-id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    type: string
                    example: MARKETING
                  components:
                    type: array
                    items:
                      type: object
                      properties:
                        buttons:
                          type: array
                          items:
                            type: object
                            properties:
                              text:
                                type: string
                                example: Stop promotions
                              type:
                                type: string
                                example: QUICK_REPLY
                          example:
                          - text: Stop promotions
                            type: QUICK_REPLY
                        example:
                          type: object
                          properties:
                            body_text:
                              type: array
                              items:
                                type: array
                                items:
                                  type: string
                                  example: Mark
                                example:
                                - Mark
                                - FALL25
                              example:
                              - - Mark
                                - FALL25
                        format:
                          type: string
                          example: TEXT
                        text:
                          type: string
                          example: Fall Sale
                        type:
                          type: string
                          example: HEADER
                    example:
                    - format: TEXT
                      text: Fall Sale
                      type: HEADER
                    - example:
                        body_text:
                        - - Mark
                          - FALL25
                      text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                      type: BODY
                    - text: Not interested in any of our sales? Tap Stop Promotions
                      type: FOOTER
                    - buttons:
                      - text: Stop promotions
                        type: QUICK_REPLY
                      type: BUTTONS
                  id:
                    type: string
                    example: '920070352646140'
                  language:
                    type: string
                    example: en_US
                  name:
                    type: string
                    example: 2023_april_promo
                  status:
                    type: string
                    example: APPROVED
              examples:
                Example response:
                  value:
                    category: MARKETING
                    components:
                    - format: TEXT
                      text: Fall Sale
                      type: HEADER
                    - example:
                        body_text:
                        - - Mark
                          - FALL25
                      text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                      type: BODY
                    - text: Not interested in any of our sales? Tap Stop Promotions
                      type: FOOTER
                    - buttons:
                      - text: Stop promotions
                        type: QUICK_REPLY
                      type: BUTTONS
                    id: '920070352646140'
                    language: en_US
                    name: 2023_april_promo
                    status: APPROVED
      security:
      - bearerAuth: []
    post:
      tags:
      - Templates
      summary: Edit template
      description: '- Guide: Message Templates

        - Guide: How To Monitor Quality Signals

        - Endpoint reference: WhatsApp Message Template'
      operationId: editTemplate
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                category:
                  type: string
                  example: MARKETING
                components:
                  type: array
                  items:
                    type: object
                    properties:
                      buttons:
                        type: array
                        items:
                          type: object
                          properties:
                            text:
                              type: string
                              example: Stop promotions
                            type:
                              type: string
                              example: QUICK_REPLY
                        example:
                        - text: Stop promotions
                          type: QUICK_REPLY
                      example:
                        type: object
                        properties:
                          body_text:
                            type: array
                            items:
                              type: array
                              items:
                                type: string
                                example: Mark
                              example:
                              - Mark
                              - FALL25
                            example:
                            - - Mark
                              - FALL25
                      format:
                        type: string
                        example: TEXT
                      text:
                        type: string
                        example: Fall Sale
                      type:
                        type: string
                        example: HEADER
                  example:
                  - format: TEXT
                    text: Fall Sale
                    type: HEADER
                  - example:
                      body_text:
                      - - Mark
                        - FALL25
                    text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                    type: BODY
                  - text: Not interested in any of our sales? Tap Stop Promotions
                    type: FOOTER
                  - buttons:
                    - text: Stop promotions
                      type: QUICK_REPLY
                    type: BUTTONS
                language:
                  type: string
                  example: en_US
                name:
                  type: string
                  example: 2023_april_promo
            examples:
              Edit template:
                value:
                  category: MARKETING
                  components:
                  - format: TEXT
                    text: Fall Sale
                    type: HEADER
                  - example:
                      body_text:
                      - - Mark
                        - FALL25
                    text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                    type: BODY
                  - text: Not interested in any of our sales? Tap Stop Promotions
                    type: FOOTER
                  - buttons:
                    - text: Stop promotions
                      type: QUICK_REPLY
                    type: BUTTONS
                  language: en_US
                  name: 2023_april_promo
      responses:
        '200':
          description: Example response
          headers:
            Access-Control-Allow-Origin:
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            Alt-Svc:
              $ref: '#/components/headers/Alt-Svc'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            Connection:
              $ref: '#/components/headers/Connection'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Date:
              $ref: '#/components/headers/Date'
            Expires:
              $ref: '#/components/headers/Expires'
            Pragma:
              $ref: '#/components/headers/Pragma'
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            Vary:
              $ref: '#/components/headers/Vary'
            X-FB-Debug:
              $ref: '#/components/headers/X-FB-Debug'
            facebook-api-version:
              $ref: '#/components/headers/facebook-api-version'
            x-business-use-case-usage:
              $ref: '#/components/headers/x-business-use-case-usage'
            x-fb-request-id:
              $ref: '#/components/headers/x-fb-request-id'
            x-fb-rev:
              $ref: '#/components/headers/x-fb-rev'
            x-fb-trace-id:
              $ref: '#/components/headers/x-fb-trace-id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
              examples:
                Example response:
                  value:
                    success: true
      security:
      - bearerAuth: []
  /{Version}/{WABA-ID}/message_templates:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    - $ref: '#/components/parameters/Authorization'
    - name: Version
      in: path
      required: true
      schema:
        type: string
    - name: WABA-ID
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Templates
      summary: Get template by name (default fields)
      description: '- Guide: Message Templates

        - Guide: How To Monitor Quality Signals

        - Endpoint reference: WhatsApp Business Account > Message Templates'
      operationId: getTemplateByNameDefaultFields
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: name
        in: query
        schema:
          type: string
          example: <TEMPLATE_NAME>
      responses:
        '200':
          description: Example response / Example response
          headers:
            Access-Control-Allow-Origin:
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            Alt-Svc:
              $ref: '#/components/headers/Alt-Svc'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            Connection:
              $ref: '#/components/headers/Connection'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Date:
              $ref: '#/components/headers/Date'
            ETag:
              $ref: '#/components/headers/ETag'
            Expires:
              $ref: '#/components/headers/Expires'
            Pragma:
              $ref: '#/components/headers/Pragma'
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            Vary:
              $ref: '#/components/headers/Vary'
            X-FB-Debug:
              $ref: '#/components/headers/X-FB-Debug'
            facebook-api-version:
              $ref: '#/components/headers/facebook-api-version'
            x-business-use-case-usage:
              $ref: '#/components/headers/x-business-use-case-usage'
            x-fb-request-id:
              $ref: '#/components/headers/x-fb-request-id'
            x-fb-rev:
              $ref: '#/components/headers/x-fb-rev'
            x-fb-trace-id:
              $ref: '#/components/headers/x-fb-trace-id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          type: string
                          example: MARKETING
                        components:
                          type: array
                          items:
                            type: object
                            properties:
                              buttons:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                      example: Stop promotions
                                    type:
                                      type: string
                                      example: QUICK_REPLY
                                example:
                                - text: Stop promotions
                                  type: QUICK_REPLY
                              example:
                                type: object
                                properties:
                                  body_text:
                                    type: array
                                    items:
                                      type: array
                                      items:
                                        type: string
                                        example: Mark
                                      example:
                                      - Mark
                                      - FALL25
                                    example:
                                    - - Mark
                                      - FALL25
                              format:
                                type: string
                                example: TEXT
                              text:
                                type: string
                                example: Fall Sale
                              type:
                                type: string
                                example: HEADER
                          example:
                          - format: TEXT
                            text: Fall Sale
                            type: HEADER
                          - example:
                              body_text:
                              - - Mark
                                - FALL25
                            text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                            type: BODY
                          - text: Not interested in any of our sales? Tap Stop Promotions
                            type: FOOTER
                          - buttons:
                            - text: Stop promotions
                              type: QUICK_REPLY
                            type: BUTTONS
                        id:
                          type: string
                          example: '920070352646140'
                        language:
                          type: string
                          example: en_US
                        name:
                          type: string
                          example: 2023_april_promo
                        status:
                          type: string
                          example: REJECTED
                    example:
                    - category: MARKETING
                      components:
                      - format: TEXT
                        text: Fall Sale
                        type: HEADER
                      - example:
                          body_text:
                          - - Mark
                            - FALL25
                        text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                        type: BODY
                      - text: Not interested in any of our sales? Tap Stop Promotions
                        type: FOOTER
                      - buttons:
                        - text: Stop promotions
                          type: QUICK_REPLY
                        type: BUTTONS
                      id: '920070352646140'
                      language: en_US
                      name: 2023_april_promo
                      status: REJECTED
                  paging:
                    type: object
                    properties:
                      cursors:
                        type: object
                        properties:
                          after:
                            type: string
                            example: MjQZD
                          before:
                            type: string
                            example: MAZDZD
              examples:
                Example response:
                  value:
                    data:
                    - category: MARKETING
                      components:
                      - format: TEXT
                        text: Hello World
                        type: HEADER
                      - text: Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform’s Cloud API. Thank you for taking the time to test with us.
                        type: BODY
                      - text: WhatsApp Business API Team
                        type: FOOTER
                      id: '1192339204654487'
                      language: en_US
                      name: hello_world
                      previous_category: ACCOUNT_UPDATE
                      status: APPROVED
                    - category: MARKETING
                      components:
                      - format: TEXT
                        text: Fall Sale
                        type: HEADER
                      - example:
                          body_text:
                          - - Mark
                            - FALL25
                        text: Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!
                        type: BODY
                      - text: Not interested in any of our sales? Tap Stop Promotions
                        type: FOOTER
                      - buttons:
                        - text: Stop promotions
                          type: QUICK_REPLY
                        type: BUTTONS
                      id: '920070352646140'
                      language: en_US
                      name: 2023_april_promo
                      status: APPROVED
                    paging:
                      cursors:
                        after: MjQZD
                        before: MAZDZD
      security:
      - bearerAuth: []
    delete:
      tags:
      - Templates
      summary: Delete template by name
      description: '- Guide: Message Templates

        - Guide: How To Monitor Quality Signals

        - Endpoint reference: WhatsApp Business Account > Message Templates'
      operationId: deleteTemplateByName
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: name
        in: query
        schema:
          type: string
          example: <TEMPLATE_NAME>
      - name: hsm_id
        in: query
        schema:
          type: string
          example: <HSM_ID>
        description: Template ID
      responses:
        '200':
          description: Example response / Example response
          headers:
            Access-Control-Allow-Origin:
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            Alt-Svc:
              $ref: '#/components/headers/Alt-Svc'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            Connection:
              $ref: '#/components/headers/Connection'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Date:
              $ref: '#/components/headers/Date'
            Expires:
              $ref: '#/components/headers/Expires'
            Pragma:
              $ref: '#/components/headers/Pragma'
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            Vary:
              $ref: '#/components/headers/Vary'
            X-FB-Debug:
              $ref: '#/components/headers/X-FB-Debug'
            facebook-api-version:
              $ref: '#/components/headers/facebook-api-version'
            x-business-use-case-usage:
              $ref: '#/components/headers/x-business-use-case-usage'
            x-fb-request-id:
              $ref: '#/components/headers/x-fb-request-id'
            x-fb-rev:
              $ref: '#/components/headers/x-fb-rev'
            x-fb-trace-id:
              $ref: '#/components/headers/x-fb-trace-id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
              examples:
                Example response:
                  value:
                    success: true
      security:
      - bearerAuth: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  headers:
    Content-Length:
      schema:
        type: string
        example: '25'
      description: Size of the response body in bytes
    x-fb-request-id:
      schema:
        type: string
        example: AGaOBl2yM-g8gdON-dhzl5y
      description: Unique identifier for the request for debugging purposes
    Expires:
      schema:
        type: string
        example: Sat, 01 Jan 2000 00:00:00 GMT
      description: Expiration date for cached responses
    Access-Control-Allow-Origin:
      schema:
        type: string
        example: '*'
      description: CORS policy allowing access from any origin
    x-fb-trace-id:
      schema:
        type: string
        example: E7riEe9OW2e
      description: Facebook trace identifier for request tracking
    Vary:
      schema:
        type: string
        example: Accept-Encoding
      description: Headers that affect caching and content negotiation
    x-business-use-case-usage:
      schema:
        type: string
        example: '{"102290129340398":[{"type":"whatsapp_business_management","call_count":1,"total_cputime":1,"total_time":1,"estimated_time_to_regain_access":0},{"type":"whatsapp","call_count":1,"total_cputime":1,"total_time":1,"estimated_time_to_regain_access":0}]}'
      description: Business use case usage metrics and rate limiting information
    Connection:
      schema:
        type: string
        example: keep-alive
      description: Connection management directive
    X-FB-Debug:
      schema:
        type: string
        example: 52zkUgodnaVRhbBE+3RiGz6TnmjmDEGunwYd+vKSc4synE+Xii//dy6twB/7yKgOJiMUuV0OF248UAZ1qL3v0A==
      description: Facebook debug information for troubleshooting
    facebook-api-version:
      schema:
        type: string
        example: v22.0
      description: Facebook Graph API version used for the request
    Strict-Transport-Security:
      schema:
        type: string
        example: max-age=15552000; preload
      description: HSTS header enforcing HTTPS connections
    Pragma:
      schema:
        type: string
        example: no-cache
      description: Legacy cache control directive
    Alt-Svc:
      schema:
        type: string
        example: h3=":443"; ma=86400
      description: Alternative service advertisement for HTTP/3
    Cache-Control:
      schema:
        type: string
        example: private, no-cache, no-store, must-revalidate
      description: Cache control directives for the response
    ETag:
      schema:
        type: string
        example: '"eb11a43a8f1e633acc57540de90158ed9ede1eb6"'
      description: Entity tag for caching and conditional requests
    Date:
      schema:
        type: string
        example: Fri, 24 Jan 2025 00:48:41 GMT
      description: Date and time when the response was generated
    x-fb-rev:
      schema:
        type: string
        example: '1019544279'
      description: Facebook internal revision number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '