Response body schema for POST v1/segments.
| Name | Type | Description |
|---|---|---|
| id | String | Unique segment ID. |
| name | String | Segment name. |
| createdAt | OffsetDateTime | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. |
| updatedAt | OffsetDateTime | Timestamp in ISO 8601 format indicating when the segment was updated. |
| type | TypeEnum | Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers. |
| filter | Object | Defines a set of criteria for an `auto-update` or `passive` segment type. |
| _object | ObjectEnum | The type of the object represented by JSON. This object stores information about the customer segment. |
| initialSyncStatus | InitialSyncStatusEnum |
| Name | Value |
|---|---|
| AUTO_UPDATE | "auto-update" |
| PASSIVE | "passive" |
| STATIC | "static" |
| Name | Value |
|---|---|
| SEGMENT | "segment" |
| Name | Value |
|---|---|
| IN_PROGRESS | "IN_PROGRESS" |
| DONE | "DONE" |