Skip to main content
PATCH
Update a segment.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the segment to update.

Body

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

Response

Segment successfully updated.

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