Segments

The Clients & Contact Segments CRUD API empowers users to manage and organise their Client and contact segments seamlessly. This API offers comprehensive functionalities for creating, reading,

get

/v1/segments

Query parameters

locationIdstring

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/segments' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "type": "client",
    "location": {
      "id": "text"
    },
    "criteria": {
      "numberOfDaysLastActivity": 1,
      "ageFrom": 1,
      "ageTo": 1,
      "gender": "Male",
      "contactStage": "Subscriber",
      "tags": [
        "text"
      ],
      "exclusionTags": [
        "text"
      ],
      "primaryLocations": [
        {
          "id": "text",
          "title": "text"
        }
      ]
    }
  }
]

200 response

post

/v1/segments

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

typestring · enumrequired

Options: client, contact

locationobjectrequired

criteriaobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/segments' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","type":"client","location":{"id":"text"},"criteria":{"numberOfDaysLastActivity":1,"ageFrom":1,"ageTo":1,"gender":"Male","contactStage":"Subscriber","tags":["text"],"exclusionTags":["text"],"primaryLocations":[{"id":"text","title":"text"}]}}'

200

200

{
  "id": "text",
  "name": "text",
  "type": "client",
  "location": {
    "id": "text"
  },
  "criteria": {
    "numberOfDaysLastActivity": 1,
    "ageFrom": 1,
    "ageTo": 1,
    "gender": "Male",
    "contactStage": "Subscriber",
    "tags": [
      "text"
    ],
    "exclusionTags": [
      "text"
    ],
    "primaryLocations": [
      {
        "id": "text",
        "title": "text"
      }
    ]
  }
}

200 response

get

/v1/segments/{segmentId}

Path parameters

segmentIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/segments/{segmentId}' \
  --header 'x-api-key: text'

200

200

{}

200 response

delete

/v1/segments/{segmentId}

Path parameters

segmentIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://<YOUR HOST>/v1/segments/{segmentId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response