​
PUT a List

PUT /user-api/v1/lists/:id

​
Headers

HeaderValue
Content-Typeapplication/json
x-rolodex-api-keyf1e2d3c4b5a697...

​
Path Parameters

​
id
string

List ID

​
Query Parameters

​
include
string

Related data to include: contacts, companies

​
Endpoint Example

PUT /user-api/v1/lists/list_99999?include=contacts

Relationship fields (contacts, companies) are replaced entirely with the provided values. To add to existing relationships, include all current values plus new ones. The type field cannot be updated after creation.

​
Request

{
  "name": "Premium VIP Contacts",
  "description": "Updated description for our premium contacts",
  "contacts": [
    "contact_123",
    "contact_999"
  ]
}

​
Response

{
  "data": {
    "id": "list_99999",
    "name": "Premium VIP Contacts",
    "type": "CONTACT",
    "description": "Updated description for our premium contacts",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T12:45:00Z"
  }
}