Update a contact list

PATCH

/api/v2/flare/contact-lists/{id}

curl --request PATCH \
  --url https://api.sipstack.com/api/v2/flare/contact-lists/example \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "name": "VIP customers (2026)", "description": "Refreshed high-value segment", "color": "#4F46E5", "isActive": true }'

• Production

Updates the provided fields of a list (name, description, color, active). Requires contacts:write. 404 when the list isn’t your organization’s.

Authorizations

• apiKeyAuth

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

All fields optional — only the provided ones change.

object

name

string

Example

VIP customers (2026)

description

string

Example

Refreshed high-value segment

color

string

Example

#4F46E5

isActive

boolean

Example

true

Responses

200

The updated list.

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

nullable

color

string

nullable

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"
  }
}

401

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"
}

404

List not found in your organization.

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"
}

503

MESSAGING_SETUP_UNAVAILABLE — your organization’s messaging account is set up automatically on its first write, and that setup failed. Nothing was written; retry shortly.

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"
}