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

# Create a template

> Creates a template and sends it for review — the same rules as in the app. It starts as pending.

Permission: A Full key.



## OpenAPI

````yaml /openapi.json post /v1/templates
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: Campaigns
  - name: Webhooks
paths:
  /v1/templates:
    post:
      tags:
        - Templates
      summary: Create a template
      description: >-
        Creates a template and sends it for review — the same rules as in the
        app. It starts as pending.


        Permission: A Full key.
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Your own unique id for this request (at most 255 characters). The
            same id and body within 24 hours answers the first answer again —
            never a second send or charge.
          schema:
            type: string
            maxLength: 255
          example: template-order-ready
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - language
                - category
              properties:
                name:
                  type: string
                  description: Lowercase letters, numbers and underscores.
                language:
                  type: string
                  description: A language code, e.g. en.
                category:
                  type: string
                  enum:
                    - marketing
                    - utility
                    - authentication
                header:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - text
                        - image
                        - video
                        - document
                    text:
                      type: string
                    url:
                      type: string
                body:
                  type: string
                footer:
                  type: string
                examples:
                  type: object
                  additionalProperties:
                    type: string
                  description: 'A sample for each variable, e.g. {"body:name": "Rohan"}.'
                buttons:
                  type: array
                  items:
                    type: object
                auth:
                  type: object
                  description: Authentication options.
            example:
              name: order_ready
              language: en
              category: utility
              body: Hi {{name}}, your order is ready.
              examples:
                body:name: Rohan
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '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.
        '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: >-
            request_id_reused: This request ID was already used for a different
            request. · template_name_taken: A template with this name already
            exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                request_id_reused:
                  value:
                    error:
                      code: request_id_reused
                      message: >-
                        This request ID was already used for a different
                        request.
                template_name_taken:
                  value:
                    error:
                      code: template_name_taken
                      message: A template with this name already exists.
        '422':
          description: >-
            media_unreachable: The media link can't be opened. ·
            media_too_large: The media file is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                media_unreachable:
                  value:
                    error:
                      code: media_unreachable
                      message: The media link can't be opened.
                media_too_large:
                  value:
                    error:
                      code: media_too_large
                      message: The media file is too large.
        '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:
    Template:
      type: object
      properties:
        name:
          type: string
        language:
          type: string
        category:
          type: string
        status:
          type: string
          enum:
            - approved
            - pending
            - rejected
            - paused
            - disabled
            - in_appeal
        rejection_reason:
          type:
            - string
            - 'null'
        quality:
          type: string
        header_type:
          type: string
        header_text:
          type: string
        body:
          type: string
        footer:
          type:
            - string
            - 'null'
        variables:
          type: integer
        buttons:
          type: array
          items:
            type: object
    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.
  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.