Dashboard
Edit Article Logout

Create or Update a Segment


This API is used to both create a new segment or update an existing segment.

When creating a segment, the id should not be included. When updating a segment, include the id of the segment to update.

HTTP Request Examples
{ "id": 18492, "name": "10DLC Do Not Contact", "description": "Customers who have opted out of 10DLC content ", "search": "", "segmentType": "Static", "is_call_list": false }
HTTP Request Parameters
idstring
Only required when updating a segment. Should be the id of the segment to update
namestringrequired
The name of the segment.
descriptionstring
The description of the segment.
searchstring
Required if the segmentType is Dynamic. Not required for static segments.
segmentTypestring
The segment type can be Static or Dynamic. If Dynamic, the search must also be specified.
is_call_listbool
A boolean (true/false) to set the segment is call list flag.
HTTP Response Examples
200
{ "Status": true, "Message": "", "Response": { "id": 136 } }


How helpful was this article?

πŸ‘ or πŸ‘Ž

Related Articles