Links
Comment on page

Segments

You can use the API to get or set segment information.

The Segment Model

Key
Type
Description
id
String
The unique identifier for the segment which is given by Tiledesk.
name
String
The segment name
match
String
all or any
createdAt
String
The time (ISO-8601 date string) when the segment was created.
filters
Array
createdBy
String
The unique identifier of the row creator
id_project
String
The unique identifier of the project
get
https://api.tiledesk.com
/v3/:project_id/segments
Get all segments
Example
curl -v -X GET -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/segments
get
https://api.tiledesk.com
/v3/:project_id/segments/:id
Get a segment by id
Example
curl -v -X GET -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/segments/5c81593adf767b0017d1aa66
post
https://api.tiledesk.com
/v3/:project_id/segments
Create a new segment
Example:
curl -v -X POST -H 'Content-Type: application/json' -u [email protected]:123456 -d '{ "name":"segment1", "filters": [{"field":"field1","operator":"=","value":"value1"}]}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/segments
put
https://api.tiledesk.com
/v3/:project_id/segments/:id
Update a segment by id
delete
https://api.tiledesk.com
/v3/:project_id/segments/:id
Delete a segment by id
Last modified 2mo ago