Update a segment.

Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules array.

PATCH https://{tenantDomain}/api/v2/experimentation/segments/{id}

Update a segment.

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/segments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<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>"
        ]
      }
    }
  ]
}
'

200

{
  "id": "<string>",
  "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>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

The ID of the segment to update.

ボディ

application/jsonapplication/x-www-form-urlencoded

Partial update of a segment. Only provided fields are updated. Sending rules replaces the entire rules array.

name · string

A human-readable name for the segment

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

description · string | null

A description of the segment

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

rules · object[]

Replaces the entire rules array.

Minimum array length: 1

Show child attributes

レスポンス

200

application/json

Segment successfully updated.

id · string · 必須

Pattern: ^seg_[A-HJ-NP-Za-km-z1-9]+$

name · string · 必須

type · enum<string> · 必須

利用可能なオプション: self, auth0

rules · object[] · 必須

Show child attributes

created_at · string<date-time> · 必須

updated_at · string<date-time> · 必須

description · string