> ## Documentation Index
> Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit referral description

> `POST /v1/referral/edit_description`

Sets or clears the private description attached to a referral-code holder. Restricted to the Builder admin that owns the referral relationship.

Set `description` to `null` to clear it. An empty string is accepted. Descriptions can contain letters, numbers, hyphens (`-`), underscores (`_`), at signs (`@`), commas (`,`), and spaces.




## OpenAPI

````yaml orderly.openapi post /v1/referral/edit_description
openapi: 3.0.1
info:
  title: EVM
  description: ''
  version: 1.0.0
servers:
  - url: https://api.orderly.org
    description: Mainnet
  - url: https://testnet-api.orderly.org
    description: Testnet
security: []
tags:
  - name: public
  - name: private
paths:
  /v1/referral/edit_description:
    post:
      tags:
        - private
      summary: Edit referral description
      description: >
        `POST /v1/referral/edit_description`


        Sets or clears the private description attached to a referral-code
        holder. Restricted to the Builder admin that owns the referral
        relationship.


        Set `description` to `null` to clear it. An empty string is accepted.
        Descriptions can contain letters, numbers, hyphens (`-`), underscores
        (`_`), at signs (`@`), commas (`,`), and spaces.
      parameters:
        - $ref: '#/components/parameters/orderly_timestamp'
        - $ref: '#/components/parameters/orderly_account_id'
        - $ref: '#/components/parameters/orderly_key'
        - $ref: '#/components/parameters/orderly_signature'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_address:
                  type: string
                  description: >-
                    User address of an existing referral-code holder under the
                    Builder.
                description:
                  type: string
                  nullable: true
                  maxLength: 50
                  pattern: ^[A-Za-z0-9_@, -]{0,50}$
                  description: >-
                    Private description for the referral-code holder. Set to
                    `null` to clear it.
              required:
                - user_address
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BasicResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        nullable: true
                        example: null
      deprecated: false
components:
  parameters:
    orderly_timestamp:
      name: orderly-timestamp
      in: header
      description: Timestamp of the signed request in milliseconds.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: '1649920583000'
    orderly_account_id:
      name: orderly-account-id
      in: header
      description: Account ID of the authenticated account.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: 6.858456565150415e+75
    orderly_key:
      name: orderly-key
      in: header
      description: Public orderly key used to sign the request.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX
    orderly_signature:
      name: orderly-signature
      in: header
      description: Signature of the request payload generated with the orderly key.
      required: true
      style: simple
      explode: false
      schema:
        type: string
      example: >-
        dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==
  schemas:
    BasicResponse:
      required:
        - success
      type: object
      properties:
        success:
          description: Indicates whether the request was successful.
          type: boolean
          example: true
        timestamp:
          description: Server timestamp in milliseconds.
          type: integer
          example: 1702989203989

````