Create a contact list
POST
/api/v2/flare/contact-lists
curl --request POST \ --url https://api.sipstack.com/api/v2/flare/contact-lists \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "VIP customers", "description": "example", "color": "#4F46E5" }'import requests
url = "https://api.sipstack.com/api/v2/flare/contact-lists"
payload = { "name": "VIP customers", "description": "example", "color": "#4F46E5"}headers = { "x-api-key": "<x-api-key>", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.sipstack.com/api/v2/flare/contact-lists';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"VIP customers","description":"example","color":"#4F46E5"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}import axios from 'axios';
const options = { method: 'POST', url: 'https://api.sipstack.com/api/v2/flare/contact-lists', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, data: {name: 'VIP customers', description: 'example', color: '#4F46E5'}};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}Creates a contact list / segment. Requires contacts:write.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
name
required
string
Example
VIP customers description
string
color
Optional UI color tag.
string
Example
#4F46E5Responses
Section titled “ Responses ”List created.
Media type application/json
object
success
boolean
data
A contact list / segment. The list endpoint adds a member_count.
object
id
string format: uuid
uuid
string format: uuid
name
string
description
string
color
string
is_active
boolean
contact_count
integer
member_count
Live membership count (list endpoint only).
integer
created_at
string format: date-time
updated_at
string format: date-time
key
additional properties
any
Example
{ "data": { "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP customers", "description": "High-value accounts for priority campaigns", "color": "#4F46E5", "is_active": true, "contact_count": 128, "member_count": 128, "created_at": "2026-01-10T11:00:00.000Z", "updated_at": "2026-01-15T09:30:00.000Z" }}name is required.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}Missing or invalid API key.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}The key is missing the contacts:write scope, or the Flare API tier is not on your plan.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}