Update Segment

put

https://{APP_DOMAIN}/api/3.2/messages/segments/{id}

Updates a static, behavior-based, or dynamic segment. The query object is re-evaluated when provided, regenerating the dynamic segment contents. AI/MCP clients creating or updating dynamic segment query payloads should call get_schema with type=segments once first.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the segment to update.

Body Params

name

string

required

Name of the segment.

description

string

required

Description of the segment.

publication_id

integer

required

ID of the associated publication. Required on create and update.

redirect_url

string

Optional redirect URL for the advanced segment.

auto_responder_id

integer

Auto responder ID to associate with the advanced segment.

is_suppression

boolean

Whether the segment is a suppression list.

suppression_type

string

Required when is_suppression is true.

result_limit

integer

Optional cap on segment membership size.

query

object

Dynamic segment builder query object. Before setting this field, fetch GET /schema?type=segments and build the object from the returned query_shape and rules. Providing query recalculates the segment's contents.

Responses

200

The updated segment

422

Failed to create the advanced segment record.

Language

Credentials

Bearer

JWT

URL

Loading…