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

# Send a template

> Sends an approved template to one person: its header (text or a file by link), one value per variable, and the values its buttons need.

Permission: A Full or Send only key.



## OpenAPI

````yaml /openapi.json post /v1/messages/template
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/messages/template:
    post:
      tags:
        - Messages
      summary: Send a template
      description: >-
        Sends an approved template to one person: its header (text or a file by
        link), one value per variable, and the values its buttons need.


        Permission: A Full or Send only 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: order-4521-update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to
                - template
              properties:
                to:
                  type: string
                  description: >-
                    The person's WhatsApp number with its country code, e.g.
                    +9198250*****.
                reference:
                  type: string
                  description: >-
                    Your own reference for this message (at most 512
                    characters). It comes back on the message and its webhooks.
                  maxLength: 512
                template:
                  type: object
                  required:
                    - name
                    - language
                  properties:
                    name:
                      type: string
                      description: The template's name.
                    language:
                      type: string
                      description: The template's language code, e.g. en.
                header:
                  type: object
                  description: Only for a template with a header variable or a file header.
                  properties:
                    text:
                      type: string
                      description: The header's one variable.
                    media:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - image
                            - video
                            - document
                        url:
                          type: string
                          description: An https link to the file.
                        filename:
                          type: string
                          description: A document's file name.
                body:
                  type: array
                  items:
                    type: string
                  description: One value per body variable, in order.
                buttons:
                  type: array
                  items:
                    type: object
                    required:
                      - index
                      - type
                      - value
                    properties:
                      index:
                        type: integer
                      type:
                        type: string
                        enum:
                          - url
                          - quick_reply
                          - copy_code
                      value:
                        type: string
            example:
              to: +9198250*****
              template:
                name: order_update
                language: en
              body:
                - Riya
                - '#4521'
      responses:
        '201':
          description: >-
            Accepted for sending. Follow its status with GET /v1/messages/{id}
            or webhooks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageAccepted'
        '400':
          description: >-
            validation_error: Some fields are missing or wrong. ·
            invalid_number: Not a valid number. · template_variables_mismatch:
            The template's variables don't match.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validation_error:
                  value:
                    error:
                      code: validation_error
                      message: Some fields are missing or wrong.
                invalid_number:
                  value:
                    error:
                      code: invalid_number
                      message: Not a valid number.
                template_variables_mismatch:
                  value:
                    error:
                      code: template_variables_mismatch
                      message: The template's variables don't match.
        '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.
        '402':
          description: 'insufficient_balance: Not enough money in your wallet.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_balance:
                  value:
                    error:
                      code: insufficient_balance
                      message: Not enough money in your wallet.
        '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.
        '404':
          description: 'template_not_found: Template not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                template_not_found:
                  value:
                    error:
                      code: template_not_found
                      message: Template not found.
        '409':
          description: >-
            request_id_reused: This request ID was already used for a different
            request. · number_not_ready: Your WhatsApp number can't send
            messages right now.
          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.
                number_not_ready:
                  value:
                    error:
                      code: number_not_ready
                      message: Your WhatsApp number can't send messages right now.
        '422':
          description: >-
            daily_limit_reached: Your daily messaging limit is reached. ·
            country_unavailable: WhatsApp isn't available in this country. ·
            no_price: Sending to this country isn't available yet. ·
            template_not_approved: This template isn't approved yet. ·
            contact_stopped: This person has stopped marketing messages. ·
            us_marketing_paused: Marketing messages can't go to US numbers. ·
            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:
                daily_limit_reached:
                  value:
                    error:
                      code: daily_limit_reached
                      message: Your daily messaging limit is reached.
                country_unavailable:
                  value:
                    error:
                      code: country_unavailable
                      message: WhatsApp isn't available in this country.
                no_price:
                  value:
                    error:
                      code: no_price
                      message: Sending to this country isn't available yet.
                template_not_approved:
                  value:
                    error:
                      code: template_not_approved
                      message: This template isn't approved yet.
                contact_stopped:
                  value:
                    error:
                      code: contact_stopped
                      message: This person has stopped marketing messages.
                us_marketing_paused:
                  value:
                    error:
                      code: us_marketing_paused
                      message: Marketing messages can't go to US numbers.
                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:
    MessageAccepted:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        to:
          type: string
        country:
          type: string
        category:
          type:
            - string
            - 'null'
        price:
          type:
            - string
            - 'null'
        reference:
          type:
            - string
            - 'null'
    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.