Skip to main content
POST
https://{tenantDomain}/api/v2
/
experimentation
/
segments
Create a segment for the Experiment Center.
curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "self",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://auth-test.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Create a segment for experiment targeting

​
name
string
required

A human-readable name for the segment

Required string length: 3 - 255
Pattern: ^(?!.*\x00)\S(.*\S)?$
​
rules
object[]
required

An ordered list of rules. A segment matches if any rule matches.

Minimum array length: 1
​
description
string

A description of the segment

Required string length: 3 - 1024
Pattern: ^(?!.*\x00)\S(.*\S)?$

Response

Segment successfully created.

​
id
string
required
Pattern: ^seg_[A-HJ-NP-Za-km-z1-9]+$
​
name
string
required
​
type
enum<string>
required
Available options:
self,
auth0
​
rules
object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string