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

# Add a tag

> Adds a tag, as Add a tag does in the app. A name another tag has (any letter case) is refused: validation_error on name, with the app's words as reason ("A tag with this name already exists."). An empty name: "A tag can't be empty.". Without colour, grey.

Permission: A Full key.



## OpenAPI

````yaml /openapi.json post /v1/tags
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/tags:
    post:
      tags:
        - Contacts
      summary: Add a tag
      description: >-
        Adds a tag, as Add a tag does in the app. A name another tag has (any
        letter case) is refused: validation_error on name, with the app's words
        as reason ("A tag with this name already exists."). An empty name: "A
        tag can't be empty.". Without colour, grey.


        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: tag-vip-buyers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: At most 40 characters.
                  maxLength: 40
                colour:
                  type: string
                  enum:
                    - green
                    - amber
                    - red
                    - grey
                  description: >-
                    One of four colours (any letter case); another:
                    validation_error on colour ("Use green, amber, red or
                    grey.").
            example:
              name: VIP buyers
              colour: amber
      responses:
        '201':
          description: Added.
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  colour:
                    type: string
                    enum:
                      - green
                      - amber
                      - red
                      - grey
              example:
                name: string
                colour: green
        '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.
          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.
        '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:
    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.