Segment
Create segment
Create a segment record.
POST
/
api-offers
/
segment
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-site-context
string
requiredThe 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
requiredName of segment
value
string[]
requiredArray of segment value
Response
200 - application/json
_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?