Skip to main content

Update Segment

PATCH 

/segments/:id

Use this API to update segment fields by using the JSON Patch standard.

Note: Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API.

Request

Path Parameters

    id stringrequired

    The segment ID to modify.

    Example: ef38f94347e94562b5bb8424a56397d8

Body

array

required

A list of segment update operations according to the JSON Patch standard.

The following fields are patchable:

  • name

  • description

  • owner

  • visibilityCriteria

  • active

  • Array [

  • object

  • ]

Responses

Indicates the PATCH operation succeeded, and returns the segment's new representation.

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...