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

Query parameters

locationIdstringOptional

limitstringOptional

pagestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

typestring · enumRequiredPossible values:

get

/v1/segments

HTTPcURLJavaScriptPython

GET /v1/segments HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

post

Header parameters

x-api-keystringRequired

Body

application/json

idstringOptional

namestringRequired

typestring · enumRequiredPossible values:

Responses

200

200 response

application/json

idstringOptional

namestringRequired

typestring · enumRequiredPossible values:

post

/v1/segments

HTTPcURLJavaScriptPython

POST /v1/segments HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 267

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

200

200 response

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

get

Path parameters

segmentIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

object · EmptySchemaOptional

get

/v1/segments/{segmentId}

HTTPcURLJavaScriptPython

GET /v1/segments/{segmentId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{}

delete

Path parameters

segmentIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

successbooleanOptional

delete

/v1/segments/{segmentId}

HTTPcURLJavaScriptPython

DELETE /v1/segments/{segmentId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}