Sign in

v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB
Segments

Create Segment

This endpoint creates a new Segment in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint.

post/v1/products/{productId}/segments

Path parameters

productIdstring uuid required

The identifier of the Product.

Request body

namestring required

Name of the Segment.

descriptionstring nullable

Description of the Segment.

comparisonAttributestring required

The user's attribute the evaluation process must take into account.

comparator'isOneOf' | 'isNotOneOf' | 'contains' | 'doesNotContain' | 'semVerIsOneOf' | 'semVerIsNotOneOf' | 'semVerLess' | 'semVerLessOrEquals' | 'semVerGreater' | 'semVerGreaterOrEquals' | 'numberEquals' | 'numberDoesNotEqual' | 'numberLess' | 'numberLessOrEquals' | 'numberGreater' | 'numberGreaterOrEquals' | 'sensitiveIsOneOf' | 'sensitiveIsNotOneOf' required

The comparison operator the evaluation process must use when it compares the given user attribute's value with the comparison value.

comparisonValuestring required

The value to compare with the given user attribute's value.

Response

When the creation was successful.

segmentIdstring uuid required

Identifier of the Segment.

namestring required

Name of the Segment.

descriptionstring nullable required

Description of the Segment.

creatorEmailstring nullable required

The email of the user who created the Segment.

creatorFullNamestring nullable required

The name of the user who created the Segment.

createdAtstring date-time required

The date and time when the Segment was created.

lastUpdaterEmailstring nullable required

The email of the user who last updated the Segment.

lastUpdaterFullNamestring nullable required

The name of the user who last updated the Segment.

updatedAtstring date-time required

The date and time when the Segment was last updated.

comparisonAttributestring required

The user's attribute the evaluation process must take into account.

comparator'isOneOf' | 'isNotOneOf' | 'contains' | 'doesNotContain' | 'semVerIsOneOf' | 'semVerIsNotOneOf' | 'semVerLess' | 'semVerLessOrEquals' | 'semVerGreater' | 'semVerGreaterOrEquals' | 'numberEquals' | 'numberDoesNotEqual' | 'numberLess' | 'numberLessOrEquals' | 'numberGreater' | 'numberGreaterOrEquals' | 'sensitiveIsOneOf' | 'sensitiveIsNotOneOf' required

The comparison operator the evaluation process must use when it compares the given user attribute's value with the comparison value.

comparisonValuestring required

The value to compare with the given user attribute's value.