PATCH
/
v1
/
parties
/
{partyId}

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.

Path Parameters

partyId
string
required

Fabric internal id for party-address.

Body

application/json
partyType
enum<string>
required
Available options:
H,
O,
P,
C
additionalAttributes
object

Contains all additional attributes not captured in the schema.

email
string

It has to be a valid email address.

internalPartyId
string

Related internal party id (Internal fabric ID)

isActive
boolean

status of the party

name
string
parentPartyId
string

Response

200 - application/json
_id
string
required

Fabric internal id of the record.

createdAt
string
required

date of creation of the record

isDeleted
boolean
required

flag that indicates if the record is deleted

partyType
enum<string>
required

party type of the party. (H, O for organization party, P, C for person party)

Available options:
H,
O,
P,
C
updatedAt
string
required

laste date of update of the record

additionalAttributes
object

Contains all additional attributes not captured in the schema.

email
string

Email of the party

internalPartyId
string

Related internal party id (Internal fabric ID)

isActive
boolean

status of the party

name
string

name of the party

parentPartyId
string

parent party id of the party (Internal fabric ID)