Skip to main content
PUT
Creates or updates a counterpart entity

Authorizations

Authorization
string
header
required

Access token obtained from the /oauth/token endpoint using your client credentials.

Body

application/json

Request body for creating or updating a counterpart entity.

counterpartCompanyIdentifier
string

Identifier of the counterpart company (from Get Companies).

name
string

Counterpart entity name.

reference
string

Your unique reference for this counterpart entity.

isActive
null | boolean

Whether this counterpart entity is active. Inactive counterpart entities cannot be referenced from nominations.

email
null | string

Contact email address for the counterpart entity.

phoneNumber
null | string

Contact phone number for the counterpart entity.

Response

OK

Response returned after creating or updating a counterpart entity.

reference
string

Your unique reference for the counterpart entity.

lastChangedAtUtc
string<date-time>

Timestamp (UTC) of the last change to the counterpart entity.