HomeTutorialsAPI ReferenceStatus
API Reference

Update Segment

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

Updates a static, behavior-based, or dynamic segment. The query object is re-evaluated when provided, regenerating the dynamic segment contents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the segment to update.

Body Params

Body Params

string

Name of the segment.

string

Description of the segment.

integer

ID of the associated publication. Required when auto_responder_id or redirect_url is set.

string

Optional redirect URL for the advanced segment.

integer

Auto responder ID to associate with the advanced segment.

boolean

Whether the segment is a suppression list.

string

Required when is_suppression is true.

integer

Optional cap on segment membership size.

query
object

Dynamic segment query. Providing this recalculates the segment's contents.

Responses
200

The updated segment

422

Failed to create the advanced segment record.

Updated about 4 hours ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…

Updated about 4 hours ago