Create Segment
POST/v1/products/:productId/segments
This endpoint creates a new Segment in a specified Product
identified by the productId
parameter, which can be obtained from the List Products endpoint.
Request
Path Parameters
The identifier of the Product.
- application/json
- text/json
- application/*+json
Body
required
Possible values: non-empty
and <= 255 characters
Name of the Segment.
Possible values: <= 1000 characters
Description of the Segment.
Possible values: non-empty
and <= 1000 characters
The user's attribute the evaluation process must take into account.
Possible values: [isOneOf
, isNotOneOf
, contains
, doesNotContain
, semVerIsOneOf
, semVerIsNotOneOf
, semVerLess
, semVerLessOrEquals
, semVerGreater
, semVerGreaterOrEquals
, numberEquals
, numberDoesNotEqual
, numberLess
, numberLessOrEquals
, numberGreater
, numberGreaterOrEquals
, sensitiveIsOneOf
, sensitiveIsNotOneOf
]
Possible values: non-empty
The value to compare with the given user attribute's value.
Body
required
Possible values: non-empty
and <= 255 characters
Name of the Segment.
Possible values: <= 1000 characters
Description of the Segment.
Possible values: non-empty
and <= 1000 characters
The user's attribute the evaluation process must take into account.
Possible values: [isOneOf
, isNotOneOf
, contains
, doesNotContain
, semVerIsOneOf
, semVerIsNotOneOf
, semVerLess
, semVerLessOrEquals
, semVerGreater
, semVerGreaterOrEquals
, numberEquals
, numberDoesNotEqual
, numberLess
, numberLessOrEquals
, numberGreater
, numberGreaterOrEquals
, sensitiveIsOneOf
, sensitiveIsNotOneOf
]
Possible values: non-empty
The value to compare with the given user attribute's value.
Body
required
Possible values: non-empty
and <= 255 characters
Name of the Segment.
Possible values: <= 1000 characters
Description of the Segment.
Possible values: non-empty
and <= 1000 characters
The user's attribute the evaluation process must take into account.
Possible values: [isOneOf
, isNotOneOf
, contains
, doesNotContain
, semVerIsOneOf
, semVerIsNotOneOf
, semVerLess
, semVerLessOrEquals
, semVerGreater
, semVerGreaterOrEquals
, numberEquals
, numberDoesNotEqual
, numberLess
, numberLessOrEquals
, numberGreater
, numberGreaterOrEquals
, sensitiveIsOneOf
, sensitiveIsNotOneOf
]
Possible values: non-empty
The value to compare with the given user attribute's value.
Responses
- 201
- 400
- 404
- 429
When the creation was successful.
- application/json
- Schema
- Example (from schema)
Schema
product
object
Details of the Product.
organization
object
Details of the Organization.
Identifier of the Organization.
Name of the Organization.
Identifier of the Product.
Name of the Product.
Description of the Product.
The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.
Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.
Identifier of the Segment.
Name of the Segment.
Description of the Segment.
The email of the user who created the Segment.
The name of the user who created the Segment.
The date and time when the Segment was created.
The email of the user who last updated the Segment.
The name of the user who last updated the Segment.
The date and time when the Segment was last updated.
The user's attribute the evaluation process must take into account.
Possible values: [isOneOf
, isNotOneOf
, contains
, doesNotContain
, semVerIsOneOf
, semVerIsNotOneOf
, semVerLess
, semVerLessOrEquals
, semVerGreater
, semVerGreaterOrEquals
, numberEquals
, numberDoesNotEqual
, numberLess
, numberLessOrEquals
, numberGreater
, numberGreaterOrEquals
, sensitiveIsOneOf
, sensitiveIsNotOneOf
]
The comparison operator the evaluation process must use when it compares the given user attribute's value with the comparison value.
The value to compare with the given user attribute's value.
{
"product": {
"organization": {
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"order": 0,
"reasonRequired": true
},
"segmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"creatorEmail": "string",
"creatorFullName": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"lastUpdaterEmail": "string",
"lastUpdaterFullName": "string",
"updatedAt": "2024-07-29T15:51:28.071Z",
"comparisonAttribute": "string",
"comparator": "isOneOf",
"comparisonValue": "string"
}
Bad request.
Not found.
Too many requests. In case of the request rate exceeds the rate limits.