Get Campaign Segments

Returns the segments associated with a campaign. If the tenant's Brand Kit has is_scheduler_include_all_segments set to true, this endpoint instead returns every segment in the tenant (useful when campaign-segment assignment is handled at send time rather than on the campaign record).

Path Parameters
idnumberrequired
The id of the campaign to return segments for
HTTP Response Examples
200
{ "Status": true, "Message": "", "Response": { "segments": [ { "tenantid": 112, "id": 137, "name": "New Customers", "description": "", "search": "s=country:United States", "status": "Active", "segmentType": "Dynamic", "total_members": 0, "total_optout_sms": 0, "total_enabled_sms": 0, "total_optout_push": 0, "total_enabled_push": 0, "total_optout_email": 0, "total_enabled_email": 0, "total_optout_phone": 0, "is_ready": true, "is_autopause": true, "date_created": "2018-09-13T00:28:43.25", "date_last_modified": "2022-02-03T08:45:14.25" } ] } }
HTTP Response Parameters
segmentsarray
An array of segments associated with the campaign.