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

# Rename Contact List

> Changes the name of a contact list.



## OpenAPI

````yaml /openapi-v1.yml patch /api/v1/contact-list/
openapi: 3.1.1
info:
  title: DeliverymanAI API V1
  version: 1.0.0
  description: >-
    API documentation for version 1 of the DeliverymanAI API. These endpoints
    drive campaigns, contact lists, leads and email sequences from your own
    code.


    V1 and V2 share the same API keys, sent in the `X-Api-Key` header.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v1/contact-list/:
    patch:
      tags:
        - Contact List
      summary: Rename Contact List
      description: Changes the name of a contact list.
      operationId: contact_list_partial_update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRenameContactListRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContactListAPI'
          description: Success
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Not Found
        '500':
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Not Available Yet
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl -X PATCH "https://api.deliveryman.ai/api/v1/contact-list/" \
              -H "X-Api-Key: YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "contact_list_uid": "cl_2f9a4c71b8e6d305",
                "name": "Q1 outreach"
              }'
components:
  schemas:
    PatchedRenameContactListRequest:
      properties:
        contact_list_uid:
          description: UID of the contact list to rename.
          minLength: 1
          title: Contact List Uid
          type: string
        name:
          description: New name for the contact list. Max 300 characters.
          maxLength: 300
          minLength: 1
          title: Name
          type: string
      required:
        - contact_list_uid
        - name
      title: RenameContactListRequest
      type: object
    GetContactListAPI:
      type: object
      properties:
        uid:
          type: string
          description: UID of this contact list.
          maxLength: 255
        workspace_id:
          type: integer
          readOnly: true
          description: ID of workspace this contact list belongs to.
        name:
          type: string
          description: Name of the contact list.
          maxLength: 300
        created_on:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Timestamp of when the contact list was created. ISO format date
            string in UTC timezone.
        status:
          type: string
          description: >-
            Current status of the contact list: `uploading` while contacts are
            being imported, `verifying` while email addresses are being
            verified, `active` when it's ready to use, or `failed` if the import
            failed.
          maxLength: 100
        source:
          type: string
          description: Source of the contact list.
          maxLength: 300
        available_columns:
          description: List of columns available in the contact list.
        has_unsubscribe_column:
          type: boolean
          description: Indicates if the contact list contains an unsubscribe column.
        unsubscribe_column_name:
          type:
            - string
            - 'null'
          description: Name of the unsubscribe column, if present.
          maxLength: 300
        contacts_count:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Number of contacts in the contact list.
        email_verification_status:
          allOf:
            - $ref: '#/components/schemas/EmailVerificationStatusEnum'
          description: |-
            Status of email address verification for this list.

            * `processing` - Processing
            * `completed` - Completed
            * `skipping` - Skipping
            * `skipped` - Skipped
            * `failed` - Failed
            * `N/A` - Not Applicable
        field_mappings:
          type: array
          items:
            $ref: '#/components/schemas/ContactListFieldMappingResponse'
          readOnly: true
          description: How the list's columns map to contact fields.
        is_deletable:
          type: boolean
          description: >-
            False while the list is used by a campaign that is created,
            scheduled, running or paused.
          readOnly: true
      required:
        - created_on
        - field_mappings
        - is_deletable
        - name
        - uid
        - workspace_id
    SimpleMessageResponse:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the result or error.
      required:
        - message
    EmailVerificationStatusEnum:
      enum:
        - processing
        - completed
        - skipping
        - skipped
        - failed
        - N/A
      type: string
      description: |-
        * `processing` - Processing
        * `completed` - Completed
        * `skipping` - Skipping
        * `skipped` - Skipped
        * `failed` - Failed
        * `N/A` - Not Applicable
    ContactListFieldMappingResponse:
      type: object
      properties:
        column:
          type: string
          description: Column name the field was imported from.
        mapped_field:
          type: string
          description: Contact field the column is stored as.
        custom_field_name:
          type:
            - string
            - 'null'
          description: Name of the custom field, if `mapped_field` is `Custom Field`.
      required:
        - column
        - mapped_field
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key, sent as the value of the `X-Api-Key` header. In the
        dashboard, go to Integrations and open Deliveryman API Keys to create
        one.

````

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