POST
a List
POST
/user-api/v1/lists
Header | Value |
---|
Content-Type | application/json |
x-rolodex-api-key | f1e2d3c4b5a697... |
Required Fields
List name (1-50 characters)
List type: CONTACT
or COMPANY
Optional Fields
List description (max 150 characters)
{
"name": "VIP Contacts",
"type": "CONTACT",
"description": "Our most important contacts and prospects",
"contacts": [
"contact_123",
"contact_456",
{
"id": "contact_789"
}
]
}
Request (Company List)
{
"name": "Target Companies",
"type": "COMPANY",
"description": "Companies we want to partner with",
"companies": [
"company_123",
{
"id": "company_456"
}
]
}
{
"data": {
"id": "list_99999",
"name": "VIP Contacts",
"type": "CONTACT",
"description": "Our most important contacts and prospects",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z",
"contacts": [
{
"id": "contact_123",
"full_name": "John Doe",
"image_url": "https://example.com/avatar1.jpg"
},
{
"id": "contact_456",
"full_name": "Jane Smith",
"image_url": "https://example.com/avatar2.jpg"
},
{
"id": "contact_789",
"full_name": "Bob Johnson",
"image_url": "https://example.com/avatar3.jpg"
}
]
}
}