Delete a specific segment

Delete a specific segment by ID.

Authorizations

Authorization

string

headerrequired

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

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-client-id

string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id

string

A unique request ID.

Path Parameters

segmentId

integer

required

Segment ID to delete the segment

Response

200 - application/json

The segment details.

id

integer

required

The segment ID.

name

string

required

The name of the segment type.

values

string[]

required

The options within a segment type.

createdAt

string

required

Record's creation time

updatedAt

string

required

Record's last updated time

isDeleted

boolean

required

true: Record is deleted<br>false: Record isn't deleted