Create segments

post

https://services.fountain.com/api/servicesegmentation/segments

Create one or more segments using the supplied details.

A segment stores criteria for selecting workers. Use the segment-members endpoint to retrieve the workers who match; the segment record itself is not a list of workers.

Body Params

name

string

required

description

string

filters

string

filterValues

string

pipeline

string

reference

object

For automatic segments, set a reference to make it easier to retrieve/update/delete when that reference changes

companyUuid

uuid

subscriptions

array of objects

subscriptions

segmentType

string

enum

Allowed:

forceMatch

boolean

Defaults to false

if true, will match worker even if they have the property segmentEnabled to true

dynamicFilters

object | null

observerRecurrence

object | null

observerTemplate

boolean

Defaults to false

when enabled, this is meant to be a template/blueprint for actual observerSegments

baseObserverSegmentUuids

array of uuids

baseObserverSegmentUuids

timezone

string

Responses

201One or many segment documents created. Wrapped in a JsonAPI root response.

500default error response