Segments - Create a new segment
POST /segments/v2/{bucket}/create
Segments are groups of records that can be used for browsing or bulk actions. A segment can be thought of as a stored query or view in traditional database terms. This endpoint creates a new segment.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The bucket (client) name
Example
exampleQuery Parameters
Section titled “Query Parameters ”URIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
Example
/example/person/6305f074683e800f3abe809e/If this is a segment of contacts, syncing will create a matching segment in mailchimp
Responses
Section titled “ Responses ”The segment created
object
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
Example
2023-09-05T11:27:06.437000The human readable value of the record the URI points to
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
Example
2023-09-05T11:27:06.437000The type of resource, usually the second element in the URI e.g person, organisation, member, payment
Example
personobject
Dynamic segments are based on a query that is run each time the segment is accessed. Static segments are lists of records. Hybrid segments are a combination of dynamic and static segments. They can support a rule with exclusions or inclusions. Auxiliary segments are nodes with no data of their own. They are used to group segments into a navigable hierarchy.
System segments are created by the system and cannot be edited or deleted.
Usually the final element in the URI, an alphanumeric unique identifier
Example
6305f074683e800f3abe809eURIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
Example
/example/person/6305f074683e800f3abe809e/object
A standard error message
object
A human readable description of the error
A concise error message
A machine readable error type
Authentication error