Segments
Create a new segment
Segments
Create a new segment
POST
/
sources
/
{source_id}
/
filter_segments
Authorizations
Authorization
string
headerrequiredBearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
source_id
integer
requiredID of the source
Body
application/json
name
string
requiredThe name of this segment.
molecules
object[]
requiredA list of Atomic Molecules, Related Segment Molecules, Relationship Molecules, Molecule Groups and at most one Operation Molecule.
business_object_id
integer
requiredThe id of the entity on which this segment is based.
Response
201 - application/json
status
enum<string>
Outcome of the operation.
Available options:
success, updated, created, not_found, error data
object
filter_segment_source_url
string
Some subproperties of the filter_segment are created asynchronously. You can query this url to fetch the status of the creation (true or false).
When status is true, it will return all properties returned in GET /sources/{source_id}/filter_segments/{segment_id}.
Was this page helpful?