POST
/
api-offers
/
segment
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/segment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "name": "Customer Type",
  "value": [
    "High Spender"
  ]
}'
{
  "_id": "614b58924e92f6861ac9d43b",
  "segmentId": 100002,
  "name": "Customer Type",
  "value": [
    "High Spender"
  ],
  "deleted": false,
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json
​
name
string
required

Name of segment

​
value
string[]
required

Array of segment value

Response

200
application/json
OK
​
_id
string

fabric internal database ObjectId of the record

​
segmentId
number

System generated unique ID of the segment

​
name
string

Name of segment

​
value
string[]

Array of segment value

​
deleted
boolean

true: Segment is deleted<br /> false: Segment is not deleted

​
createdAt
string

Creation date of the record

​
updatedAt
string

Last updated date of the record

Was this page helpful?

Get a specific segmentOverview