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

# Template library

> WhatsApp's ready-made Utility and Authentication templates your number can use. Their words can't be changed; create one with POST /v1/templates and library_template. Templates with buttons we don't support yet are left out.

Permission: Any key (Full, Send only or Read only).



## OpenAPI

````yaml /openapi.json get /v1/templates/library
openapi: 3.1.0
info:
  title: GetReply API
  version: 1.0.0
  description: >-
    Send WhatsApp messages, templates, OTPs and campaigns from your own
    software. Every request needs an API key (Developer → API keys) as a Bearer
    token.


    Requests sent here are real and charged like any other.
servers:
  - url: https://api.getreply.in
    description: GetReply
security:
  - bearerAuth: []
tags:
  - name: Account
  - name: Messages
  - name: Templates
  - name: Contacts
  - name: Inbox
  - name: Campaigns
  - name: Webhooks
  - name: Request log
paths:
  /v1/templates/library:
    get:
      tags:
        - Templates
      summary: Template library
      description: >-
        WhatsApp's ready-made Utility and Authentication templates your number
        can use. Their words can't be changed; create one with POST
        /v1/templates and library_template. Templates with buttons we don't
        support yet are left out.


        Permission: Any key (Full, Send only or Read only).
      parameters:
        - name: language
          in: query
          required: false
          description: en (default), hi, gu, mr, ta, te, bn, kn, ml, pa or ur.
          schema:
            type: string
        - name: category
          in: query
          required: false
          description: utility (default) or authentication.
          schema:
            type: string
        - name: topic
          in: query
          required: false
          description: orders, payments, appointments, account, feedback or other.
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: Words in the name, header or message.
          schema:
            type: string
      responses:
        '200':
          description: The library templates.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LibraryTemplate'
                  total:
                    type: integer
              example:
                data:
                  - name: string
                    language: string
                    category: utility
                    topic: orders
                    meta_topic: string
                    meta_usecase: string
                    header:
                      type: text
                      text: string
                    body: string
                    body_examples:
                      - string
                    footer: string
                    buttons:
                      - type: string
                        text: string
                    needs:
                      - index: 1
                        input: url
                total: 1
        '400':
          description: 'validation_error: Some fields are missing or wrong.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validation_error:
                  value:
                    error:
                      code: validation_error
                      message: Some fields are missing or wrong.
                      field: buttons[0].phone
                      reason: Add a valid phone number.
        '401':
          description: 'unauthorized: API key is missing or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error:
                      code: unauthorized
                      message: API key is missing or not valid.
        '403':
          description: >-
            key_off: This API key is switched off. · forbidden_scope: This API
            key isn't allowed to do this. · ip_not_allowed: Requests from this
            IP address aren't allowed for this key. · needs_pro_plan: The API
            needs the Pro plan. · plan_ended: Your plan has ended. Renew it to
            send messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                key_off:
                  value:
                    error:
                      code: key_off
                      message: This API key is switched off.
                forbidden_scope:
                  value:
                    error:
                      code: forbidden_scope
                      message: This API key isn't allowed to do this.
                ip_not_allowed:
                  value:
                    error:
                      code: ip_not_allowed
                      message: >-
                        Requests from this IP address aren't allowed for this
                        key.
                needs_pro_plan:
                  value:
                    error:
                      code: needs_pro_plan
                      message: The API needs the Pro plan.
                plan_ended:
                  value:
                    error:
                      code: plan_ended
                      message: Your plan has ended. Renew it to send messages.
        '409':
          description: >-
            number_not_ready: Your WhatsApp number can't send messages right
            now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                number_not_ready:
                  value:
                    error:
                      code: number_not_ready
                      message: Your WhatsApp number can't send messages right now.
        '429':
          description: 'rate_limited: Too many requests. Try again in a few seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error:
                      code: rate_limited
                      message: Too many requests. Try again in a few seconds.
        '500':
          description: 'server_error: Something went wrong on our side. Try again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_error:
                  value:
                    error:
                      code: server_error
                      message: Something went wrong on our side. Try again.
components:
  schemas:
    LibraryTemplate:
      type: object
      properties:
        name:
          type: string
          description: Use it as library_template.
        language:
          type: string
        category:
          type: string
          enum:
            - utility
            - authentication
        topic:
          type: string
          enum:
            - orders
            - payments
            - appointments
            - account
            - feedback
            - other
        meta_topic:
          type:
            - string
            - 'null'
        meta_usecase:
          type:
            - string
            - 'null'
        header:
          type:
            - object
            - 'null'
          properties:
            type:
              type: string
              enum:
                - text
                - image
                - video
                - document
                - location
            text:
              type: string
        body:
          type: string
          description: 'Numbered variables: {{1}}, {{2}} …, filled when you send.'
        body_examples:
          type: array
          items:
            type: string
        footer:
          type:
            - string
            - 'null'
        buttons:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              text:
                type: string
        needs:
          type: array
          description: What button_inputs must give.
          items:
            type: object
            properties:
              index:
                type: integer
              input:
                type: string
                enum:
                  - url
                  - phone_number
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: >-
                The one field that is wrong, when there is one: its path in your
                request, 0-based for lists, e.g. buttons[0].phone, header.text,
                audience.numbers[12].to.
              example: buttons[0].phone
            reason:
              type: string
              description: >-
                validation_error only: what is wrong with that field, in plain
                words, when we have words for that check. Left out otherwise.
              example: Add a valid phone number.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. gr_live_…

````

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