POST https://restapi.actonsoftware.com/ucl/v2/segment/{accountId}/list
This endpoint allows you to create a new All Contacts segment in the account.
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| authorization | header | false | required | string | Insert your generated access token. (Bearer {access token}) |
| accountId | Path | false | required | number | Account ID where query needs to be done |
| segmentName | Body | false | required | String | Specify the name |
| filter | Body | false | required | “search” / “directSelect” | Specify the segment type |
| patterns | Body | false | optional | String | Using a semicolon as the delimiter specifies the words to filter a search segment. |
| recIds | Body | false | optional | String | Use a semicolon as the delimiter to specify the records you would like to have in a direct segment. |
Response
{
"id": 103525,
"createdTime": 1654532788980,
"updatedTime": 1654532789029,
"accountId": 864,
"enabled": true,
"externalId": "g-0452",
"item": "{\"parent\":\"l-unified-contacts\",\"lastCountDate\":1654532788941,\"recordsCount\":0,\"isEditable\":true,\"name\":\"Example segment\",\"id\":\"g-0452\",\"type\":\"Direct Select\"}",
"folderId": null,
"authorId": "827",
"username": null,
"position": 0,
"isFavorite": false,
"labels": [],
"hasToAudit": false
}
Code Examples
cURL
curl -X POST https://restapi.actonsoftware.com/ucl/v2/segment/{accountId}/list -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"
