Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Segments

PATCH (rename) a Segment

Use this method to update an existing segment name with a new unique name in the request body. For more use case information, see Rename a Segment in the API guide.

patch/segments/{segment_id}/name

Path parameters

segment_idinteger required

The system generated ID that uniquely identifies the segment that you want to modify.

Request body

namestring required

The segment's unique descriptive name.

Example request

{
  "name": "Contacts who did not open any email campaign within the last 100 days."
}

Response

The segment name was successfully updated.

namestring

The segment's unique descriptive name.

segment_criteriastring

The segment's contact selection criteria formatted as single-string escaped JSON.

segment_idinteger

The system generated number that uniquely identifies the segment.

created_atstring date-time

The system generated date and time (ISO-8601) that the segment was created.

edited_atstring date-time

The system generated date and time (ISO-8601) that the segment's <code>name</code> or <code> segment_criteria</code> was last updated.

Example response

{
  "name": "Re-engage contacts who did not open the last 5 email campaign activities.",
  "segment_criteria": "{\"version\":\"1.0.0\",\"criteria\":{\"type\":\"and\",\"group\":[{\"source\":\"tracking\",\"field\":\"not_opened\",\"op\":\"contains-any\",\"const_value\":\"last-n-campaigns\",\"param\":\"5\"}]}}",
  "segment_id": 14,
  "created_at": "2019-04-25T11:08:00.000Z",
  "edited_at": "2019-04-25T11:08:00.000Z"
}