Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 1.26 KB

SegmentsGetResponseBody.md

File metadata and controls

46 lines (26 loc) · 1.26 KB

SegmentsGetResponseBody

Response body schema for GET v1/v1/segments/{segmentId}.

Properties

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.
type TypeEnum Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).
filter Object Defines a set of criteria for an `auto-update` segment type.
initialSyncStatus InitialSyncStatusEnum
_object ObjectEnum The type of the object represented by JSON. This object stores information about the customer segment.

Enum: TypeEnum

Name Value
AUTO_UPDATE "auto-update"
STATIC "static"

Enum: InitialSyncStatusEnum

Name Value
IN_PROGRESS "IN_PROGRESS"
DONE "DONE"

Enum: ObjectEnum

Name Value
SEGMENT "segment"