Skip to navigation

Create Filter Segment

View as Markdown
Save a new filter segment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Headers

Idempotency-Keystring or nullOptional>=8 characters
A unique key for this request. A retry with the same key returns the first response instead of running again, for 24 hours. Keys are per caller.

Request

This endpoint expects an object.
modulestringRequired1-64 characters
Module key identifying which page the segment belongs to
namestringRequired1-80 characters

User-provided segment name

filterslist of objectsRequired
Filter predicates to save

Response

Successful Response
idstring
modulestring
namestring
filterslist of objects
created_by_user_idstring or null
created_atdatetime
updated_atdatetime

Errors

422
Unprocessable Entity Error