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

# Edit your business profile

> Changes only the fields you give; the rest stay. The app's rules: about at most 139 characters, address 256, description 512, email 128; one website (https or http); category one of WhatsApp's categories (e.g. retail).

Permission: A Full key.



## OpenAPI

````yaml /openapi.json patch /v1/profile
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/profile:
    patch:
      tags:
        - Account
      summary: Edit your business profile
      description: >-
        Changes only the fields you give; the rest stay. The app's rules: about
        at most 139 characters, address 256, description 512, email 128; one
        website (https or http); category one of WhatsApp's categories (e.g.
        retail).


        Permission: A Full key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                about:
                  type:
                    - string
                    - 'null'
                address:
                  type:
                    - string
                    - 'null'
                description:
                  type:
                    - string
                    - 'null'
                email:
                  type:
                    - string
                    - 'null'
                websites:
                  type: array
                  maxItems: 1
                  items:
                    type: string
                category:
                  type: string
            example:
              about: Open 9 am to 9 pm, every day.
              websites:
                - https://example.com
      responses:
        '200':
          description: The profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '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: >-
            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:
    Profile:
      type: object
      properties:
        about:
          type:
            - string
            - 'null'
        address:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        websites:
          type: array
          items:
            type: string
        category:
          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.