POST
/
v1
/
internal-parties

Authorizations

Authorization
string
headerrequired

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
internalPartyType
enum<string>
required

type of the internal party

Available options:
O,
H,
P,
C
parentInternalPartyId
string

parent internal party ID of the internal party (Internal fabric ID)

name
string

name of the internal party

isActive
boolean

status of the internal party

email
string

It has to be a valid email address.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Response

200 - application/json
_id
string
required

Fabric internal id of the record.

internalPartyType
enum<string>
required

party type.

Available options:
O,
H,
P,
C
isDeleted
boolean
required

flag that indicates if the record is deleted

createdAt
string
required

date of creation of the record

updatedAt
string
required

laste date of update of the record

parentInternalPartyId
string

parent internal party ID of the internal party (Internal fabric ID)

employeeIdentifier
string

employee identifier

name
string

name of the internal party

isActive
boolean

status of the internal party

email
string

Email of the internal party

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Was this page helpful?

Delete internal partyList internal parties