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

# Edit Recipient List

> # Description

Patch attributes for a recipient list instance where `recipientListId` is the id to patch.

# Body
```json
{
  "name": string,
}
```
where:  

- `name`: New name of the recipient list.


# Response
```json
{
    "name": string,
    "createdAt": string,
    "updatedAt": string,
    "id": string,
    "companyId": string,
    "recipientsCount": number,
    "audienceId": string
}
```

where:

- `name`: Name of the recipient list.  
- `createdAt`: Creation date of the recipient list.  
- `updateAt`: Last date of update of the recipient list.  
- `id`: Recipient list id.  
- `audienceId`: Audience id of the audience the recipient list belongs to. *Optional*.  
- `recipientsCount`: Total number of recipients in the list.  
- `companyId`: Company owner of the recipient list.

# Description

Patch attributes for a recipient list instance where `recipientListId` is the id to patch.

# Body

```json theme={null}
{
  "name": string,
}
```

where:

* `name`: New name of the recipient list.

# Response

```json theme={null}
{
    "name": string,
    "createdAt": string,
    "updatedAt": string,
    "id": string,
    "companyId": string,
    "recipientsCount": number,
    "audienceId": string
}
```

where:

* `name`: Name of the recipient list.
* `createdAt`: Creation date of the recipient list.
* `updateAt`: Last date of update of the recipient list.
* `id`: Recipient list id.
* `audienceId`: Audience id of the audience the recipient list belongs to. *Optional*.
* `recipientsCount`: Total number of recipients in the list.
* `companyId`: Company owner of the recipient list.


## OpenAPI

````yaml PATCH /campaigns-service/v1/recipientLists/{recipientListId}
openapi: 3.0.3
info:
  title: SightX API
  version: 1.0.0
  description: >-
    SightX REST API documentation. Most responses are JSON; some export
    endpoints return files. API access is a paid add-on — contact
    sales@sightx.io for details.
servers:
  - url: https://auth.admin.sightx.io
    description: Authentication (Production)
  - url: https://auth.staging-admin.sightx.io
    description: Authentication (Staging)
security:
  - AuthorizationHeader: []
paths:
  /campaigns-service/v1/recipientLists/{recipientListId}:
    patch:
      summary: Edit Recipient List
      description: >-
        # Description


        Patch attributes for a recipient list instance where `recipientListId`
        is the id to patch.


        # Body

        ```json

        {
          "name": string,
        }

        ```

        where:  


        - `name`: New name of the recipient list.



        # Response

        ```json

        {
            "name": string,
            "createdAt": string,
            "updatedAt": string,
            "id": string,
            "companyId": string,
            "recipientsCount": number,
            "audienceId": string
        }

        ```


        where:


        - `name`: Name of the recipient list.  

        - `createdAt`: Creation date of the recipient list.  

        - `updateAt`: Last date of update of the recipient list.  

        - `id`: Recipient list id.  

        - `audienceId`: Audience id of the audience the recipient list belongs
        to. *Optional*.  

        - `recipientsCount`: Total number of recipients in the list.  

        - `companyId`: Company owner of the recipient list.
      operationId: >-
        edit-recipient-list-patch-campaigns-service-v1-recipientlists-recipientlistid
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example:
              name: New recipient list name
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      servers:
        - url: https://campaigns.sightx.io
components:
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Access token obtained from the m2m-token endpoint.

````