DELETE
/
v1
/
internal-parties
/
{internalPartyId}
Delete Internal Party
curl --request DELETE \
  --url https://live.copilot.fabric.inc/data-customer/v1/internal-parties/{internalPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "61df41892bf06d00092d0d8a",
  "parentInternalPartyId": "61df41892bf06d00092d0d8f",
  "name": "INTERNAL PARTY Section 1",
  "internalPartyType": "O",
  "isActive": true,
  "email": "org@gmail.com",
  "additionalAttributes": {},
  "isDeleted": true,
  "createdAt": "2021-08-30T23:20:42.822Z",
  "updatedAt": "2021-08-30T23:20:42.822Z"
}

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
internalPartyId
string
required

Can either refer to employeeIdentifier or the Fabric internal id of the record

Example:

"61a558b1b155125f02be7fb1"

Response

Sample response

​
_id
string
required

Fabric internal id of the record.

Example:

"61df41892bf06d00092d0d8a"

​
internalPartyType
enum<string>
required

party type.

Available options:
O,
H,
P,
C
Example:

"O"

​
isDeleted
boolean
required

flag that indicates if the record is deleted

Example:

true

​
createdAt
string<date-time>
required

date of creation of the record

Example:

"2021-08-30T23:20:42.822Z"

​
updatedAt
string<date-time>
required

laste date of update of the record

Example:

"2021-08-30T23:20:42.822Z"

​
parentInternalPartyId
string

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

Example:

"61df41892bf06d00092d0d8f"

​
name
string

name of the internal party

Example:

"INTERNAL PARTY Section 1"

​
isActive
boolean

status of the internal party

Example:

true

​
email
string

Email of the internal party

Example:

"org@gmail.com"

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.