Create Segment
POST {{baseUrl}}/api/segments/
Create a segment.
Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d
Scopes:
segments:write
Request Body
{"data"=>{"type"=>"segment", "attributes"=>{"name"=>"<string>", "definition"=>{"condition_groups"=>[{"conditions"=>[{"type"=>"profile-group-membership", "is_member"=>true, "group_ids"=>["<string>", "<string>"], "timeframe_filter"=>{"type"=>"date", "operator"=>"after", "date"=>"<dateTime>"}}, {"type"=>"profile-group-membership", "is_member"=>true, "group_ids"=>["<string>", "<string>"], "timeframe_filter"=>{"type"=>"date", "operator"=>"after", "date"=>"<dateTime>"}}]}, {"conditions"=>[{"type"=>"profile-group-membership", "is_member"=>true, "group_ids"=>["<string>", "<string>"], "timeframe_filter"=>{"type"=>"date", "operator"=>"after", "date"=>"<dateTime>"}}, {"type"=>"profile-group-membership", "is_member"=>true, "group_ids"=>["<string>", "<string>"], "timeframe_filter"=>{"type"=>"date", "operator"=>"before", "date"=>"<dateTime>"}}]}]}, "is_starred"=>false}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"segment","id":"\u003cstring\u003e","attributes":{"is_active":"\u003cboolean\u003e","is_processing":"\u003cboolean\u003e","is_starred":"\u003cboolean\u003e","name":"\u003cstring\u003e","definition":{"condition_groups":[{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"before","date":"\u003cdateTime\u003e"}}]},{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"before","date":"\u003cdateTime\u003e"}}]}]},"created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"data":[{"type":"profile","id":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}