> ## 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 contact card

> Sends one or more contact cards, inside the 24-hour window. Each card is WhatsApp's contact object; name.formatted_name is needed. Not switched on for every account yet: not_available until it is.

Permission: A Full or Send only key.



## OpenAPI

````yaml /openapi.json post /v1/messages/contact-card
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
paths:
  /v1/messages/contact-card:
    post:
      tags:
        - Messages
      summary: Send a contact card
      description: >-
        Sends one or more contact cards, inside the 24-hour window. Each card is
        WhatsApp's contact object; name.formatted_name is needed. Not switched
        on for every account yet: not_available until it is.


        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: card-support-1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - to
                - contacts
              properties:
                to:
                  type: string
                  description: >-
                    The person's WhatsApp number with its country code, e.g.
                    +9198250***** — or their WhatsApp username id (e.g.
                    "IN.1626…"; see Customer).
                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
                contacts:
                  type: array
                  items:
                    type: object
                    required:
                      - name
                    properties:
                      name:
                        type: object
                        required:
                          - formatted_name
                        properties:
                          formatted_name:
                            type: string
                          first_name:
                            type: string
                          last_name:
                            type: string
                      phones:
                        type: array
                        items:
                          type: object
                          properties:
                            phone:
                              type: string
                            type:
                              type: string
                            wa_id:
                              type: string
                      emails:
                        type: array
                        items:
                          type: object
                      org:
                        type: object
                      urls:
                        type: array
                        items:
                          type: object
                      addresses:
                        type: array
                        items:
                          type: object
                      birthday:
                        type: string
                        description: YYYY-MM-DD
                reply_to:
                  type: string
                  description: The id of a message to quote.
            example:
              to: +9198250*****
              contacts:
                - name:
                    formatted_name: GetReply Support
                  phones:
                    - phone: +9198250*****
                      type: WORK
      responses:
        '201':
          description: Accepted for sending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageAccepted'
        '400':
          description: >-
            validation_error: Some fields are missing or wrong. ·
            invalid_number: Not a valid number.
          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.
        '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. · not_available: This isn't available yet.
          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.
                not_available:
                  value:
                    error:
                      code: not_available
                      message: This isn't available yet.
        '404':
          description: 'not_found: Not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  value:
                    error:
                      code: not_found
                      message: 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. ·
            outside_24h_window: The 24-hour reply window is closed. Send a
            template instead.
          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.
                outside_24h_window:
                  value:
                    error:
                      code: outside_24h_window
                      message: >-
                        The 24-hour reply window is closed. Send a template
                        instead.
        '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
            - 'null'
        customer:
          $ref: '#/components/schemas/Customer'
        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.
    Customer:
      type: object
      description: >-
        Who the customer is. phone can be null: a customer who uses a WhatsApp
        username may not share their number. user_id is WhatsApp's
        business-scoped user ID (for example "IN.13491208655302741918").
      properties:
        phone:
          type:
            - string
            - 'null'
        user_id:
          type:
            - string
            - 'null'
        username:
          type:
            - string
            - 'null'
  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.