- Product Docs
- Engineering Blog
- Users
- Invitations
- Workspaces
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
Organization APIs
Workspace APIs
Update segment
Update certain values of a specified segment
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
ID of the source
ID of the segment
The name of this segment.
A list of Atomic Molecules, Related Segment Molecules, Relationship Molecules, Molecule Groups and at most one Operation Molecule.
Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
ID of the source
ID of the segment
Body
The name of this segment.
A list of Atomic Molecules, Related Segment Molecules, Relationship Molecules, Molecule Groups and at most one Operation Molecule.
Represents the property name when attribute_type
is property and the column name when attribute_type
is column.
The type of the attribute for this condition. Options are:
property
for entity propertiessql
for sql conditionscolumn
for legacy segments
property
, sql
, column
The operator for this molecule. Only certain operators will be valid for a given property type. For example, the greaterthan
operator can only be applied to numeric values.
isnull
, isnotnull
, between
, in
, exactly
, isnot
, starts
, ends
, contains
, nocontains
, isblank
, isnotblank
, equals
, notexactly
, lessthan
, greaterthan
, intop
, inbottom
, true
, false
, morethandays
, lessthandays
, exactlydays
, after
, on
, before
If the attribute_type
is sql
, then this is a SQL string. Otherwise the value being filtered on.
- a number for numerical operators
- a string for string operators
- a boolean for boolean operators
- an array for array operators
- for datetime operators, this could either be a datetime value, a number (for “morethandays” type operators), or a “between” value which is represented as a hash with the following structure
{ bound_one: X, bound_two: Y }
. X and Y are either datetime values, blank (in which case they become the current datetime on the backend), or a string with the following structure "days_ago: Z" where Z is a number (can be decimal).
Response
Outcome of the operation.
success
, updated
, created
, not_found
, error
The type of this source object, will always be segment
.
segment
The id of this segment.
The name of this segment.
The source object id for this model.
The id of the model that this filter segment is related to (either directly from legacy segments or indirectly via the entity)
The SQL query associated with this segment.
The cached size of the segment at that particular moment in time.
When this segment was created.
When this segment was last updated.
The unique identifier for this filter segment.
A list of Atomic Molecules, Related Segment Molecules, Relationship Molecules, Molecule Groups and at most one Operation Molecule.
Represents the property name when attribute_type
is property and the column name when attribute_type
is column.
The type of the attribute for this condition. Options are:
property
for entity propertiessql
for sql conditionscolumn
for legacy segments
property
, sql
, column
The operator for this molecule. Only certain operators will be valid for a given property type. For example, the greaterthan
operator can only be applied to numeric values.
isnull
, isnotnull
, between
, in
, exactly
, isnot
, starts
, ends
, contains
, nocontains
, isblank
, isnotblank
, equals
, notexactly
, lessthan
, greaterthan
, intop
, inbottom
, true
, false
, morethandays
, lessthandays
, exactlydays
, after
, on
, before
If the attribute_type
is sql
, then this is a SQL string. Otherwise the value being filtered on.
- a number for numerical operators
- a string for string operators
- a boolean for boolean operators
- an array for array operators
- for datetime operators, this could either be a datetime value, a number (for “morethandays” type operators), or a “between” value which is represented as a hash with the following structure
{ bound_one: X, bound_two: Y }
. X and Y are either datetime values, blank (in which case they become the current datetime on the backend), or a string with the following structure "days_ago: Z" where Z is a number (can be decimal).
Was this page helpful?