Skip to main content

Create Segment

POST 

/segments

This API creates a segment.

Note: Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.

Request

Body

required

    id string

    The segment's ID.

    name string

    The segment's business name.

    created date-time

    The time when the segment is created.

    modified date-time

    The time when the segment is modified.

    description string

    The segment's optional description.

    owner

    object

    nullable

    The owner of this object.

    type string

    Possible values: [IDENTITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    id string

    Identity id

    name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    visibilityCriteria

    object

    nullable

    expression

    object

    operator string

    Possible values: [AND, EQUALS]

    Operator for the expression

    attribute stringnullable

    Name for the attribute

    value

    object

    nullable

    type stringnullable

    The type of attribute value

    value string

    The attribute value

    children

    object[]

    nullable

    List of expressions

  • Array [

  • operator string
    attribute string

    value

    object

    nullable

    type stringnullable

    The type of attribute value

    value string

    The attribute value

    children stringnullable
  • ]

  • active boolean

    This boolean indicates whether the segment is currently active. Inactive segments have no effect.

Responses

Segment created

Schema

    id string

    The segment's ID.

    name string

    The segment's business name.

    created date-time

    The time when the segment is created.

    modified date-time

    The time when the segment is modified.

    description string

    The segment's optional description.

    owner

    object

    nullable

    The owner of this object.

    type string

    Possible values: [IDENTITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    id string

    Identity id

    name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    visibilityCriteria

    object

    nullable

    expression

    object

    operator string

    Possible values: [AND, EQUALS]

    Operator for the expression

    attribute stringnullable

    Name for the attribute

    value

    object

    nullable

    type stringnullable

    The type of attribute value

    value string

    The attribute value

    children

    object[]

    nullable

    List of expressions

  • Array [

  • operator string
    attribute string

    value

    object

    nullable

    type stringnullable

    The type of attribute value

    value string

    The attribute value

    children stringnullable
  • ]

  • active boolean

    This boolean indicates whether the segment is currently active. Inactive segments have no effect.

Loading...