Skip to main content

Update Segment

Update an existing segment by its ID. You can change the segment name, filter condition, and filter rules.


Endpoint

PATCH https://api.campaignlark.com/v1/segments/:id

Path Parameters

ParameterTypeRequiredDescription
idintegerrequiredThe segment ID.

Request Body

Same structure as Create Segment.

FieldTypeRequiredDescription
namestringrequiredSegment name. 1–64 characters.
filtersobjectrequiredFilter configuration object.
filters.conditionstringrequiredLogical operator to combine filters. Must be AND or OR.
filters.filtersarrayrequiredArray of filter objects. At least one filter is required. See Filter Types for the full schema.

Sample Request

PATCH https://api.campaignlark.com/v1/segments/1
Content-Type: application/json

{
"name": "Updated Segment Name",
"filters": {
"condition": "OR",
"filters": [
{
"type": "tags",
"operator": "contains",
"value": [1, 3]
}
]
}
}

Response

Success — 200 OK

Asynchronously re-queues segment member calculation after update.

{
"data": {
"id": 1,
"name": "Updated Segment Name",
"filters": {
"condition": "OR",
"filters": [
{
"type": "tags",
"operator": "contains",
"value": [1, 3]
}
]
},
"contact_count": 1500,
"last_calculated_at": "2026-04-09T02:00:00Z",
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-04-09T02:25:00Z"
}
}

Errors

StatusMessageCause
400Please provide a valid segment ID.id path parameter is missing or invalid.
400Segment not foundSegment does not exist in this workspace.
400All validation errors from Create SegmentInvalid name, filter condition, or filter rules.