POpocketflows
Segments

Create a segment

post/businesses/{id}/segments

Request

Path parameters

idstring required

The ID of the business

Request body

namestring required

The name of the segment

static_customersstring[]

A list of customer IDs to always include in this segment

customersstring[]

A list of customer IDs to include in this segment

filterstring nullable

The filter for this segment

descriptionstring nullable

A plain-English description of the segment using bullet-point markdown

metadataobject

Metadata attached to this segment

Response

The created Segment object

idstring required

The ID of the segment

namestring required

The name of the segment

filterstring nullable required

The filter for this segment

descriptionstring nullable required

A Markdown description of the filter

metadataobject

Metadata attached to this segment

static_customersstring[]

The customers that are always included in this segment

Changes

No recorded changes to this operation across all 10 revisions of this API.