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

# Update a list

> Renames the list and/or changes its group. Send at least one field. `"groupName": null` clears the group.



## OpenAPI

````yaml PATCH /contact-lists/{id}
openapi: 3.0.3
info:
  title: PowerDialer Public API
  version: '1.0'
  description: >-
    Manage PowerDialer contact lists and read a user's call analytics
    server-to-server.


    Every request carries the shared API key (`Authorization: Bearer <key>` or
    `x-api-key: <key>`) and the PowerDialer user it acts for (`x-user-email` or
    `x-user-id`). Reads and writes are limited to lists that user owns;
    analytics are that user's own.


    Rate limit: 300 requests per minute per API key, across all users.
servers:
  - url: https://api.migration.powerdialer.ai/api/public/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Contact lists
    description: Create, update and delete lists.
  - name: Contacts
    description: Add and remove contacts in a list.
  - name: Analytics
    description: The acting user's call analytics.
paths:
  /contact-lists/{id}:
    parameters:
      - $ref: '#/components/parameters/ListId'
    patch:
      tags:
        - Contact lists
      summary: Update a list
      description: >-
        Renames the list and/or changes its group. Send at least one field.
        `"groupName": null` clears the group.
      operationId: updateContactList
      parameters:
        - $ref: '#/components/parameters/UserEmail'
        - $ref: '#/components/parameters/UserId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactListRequest'
            example:
              name: Partner leads Q4
              groupName: null
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactList'
              example:
                id: 4821
                name: Partner leads Q4
                groupName: null
                contactsCount: 2
                orgId: org_2xyz...
                createdAt: '2026-10-06T12:00:00.000Z'
                updatedAt: '2026-10-06T12:05:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/ListNotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    ListId:
      name: id
      in: path
      required: true
      description: Id of the contact list, from the create response.
      schema:
        type: integer
        example: 4821
    UserEmail:
      name: x-user-email
      in: header
      required: false
      description: >-
        Login email of the PowerDialer user the request acts for. Send this or
        `x-user-id`; if both are sent, `x-user-id` wins.
      schema:
        type: string
        format: email
        example: rep@company.com
    UserId:
      name: x-user-id
      in: header
      required: false
      description: >-
        Clerk user id of the PowerDialer user the request acts for. Send this or
        `x-user-email`.
      schema:
        type: string
        example: user_2abc...
  schemas:
    UpdateContactListRequest:
      type: object
      additionalProperties: false
      description: Send at least one field.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
          example: Partner leads Q4
        groupName:
          type: string
          maxLength: 100
          nullable: true
          description: '`null` clears the group.'
    ContactList:
      type: object
      required:
        - id
        - name
        - groupName
        - contactsCount
        - orgId
        - createdAt
        - updatedAt
      properties:
        id:
          type: integer
          example: 4821
        name:
          type: string
          example: Partner leads October
        groupName:
          type: string
          nullable: true
          example: Partner
        contactsCount:
          type: integer
          example: 2
        orgId:
          type: string
          example: org_2xyz...
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        duplicatesInPayload:
          type: integer
          description: Present only when the create payload repeated a phone number.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        details:
          description: Optional. A string, or for validation errors a list of problems.
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
  responses:
    BadRequest:
      description: >-
        Malformed body or query, unknown field, missing user header, impossible
        date.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid request
            details:
              - path: contacts.0.phoneNumber
                message: phoneNumber is required
    Unauthorized:
      description: Missing or wrong API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API key
    ListNotFound:
      description: List not found, or not owned by the acting user.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Contact list not found
    RateLimited:
      description: More than 300 requests per minute for this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate limit exceeded
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        `Authorization: Bearer <api key>`. The key is issued by PowerDialer and
        must stay on your server.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Alternative to the Authorization header: `x-api-key: <api key>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.