Update ContractContact - Nexudus Platform

PUT

api

billing

contractcontacts

Update ContractContact

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/contractcontacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerContractId": 123,
  "FullName": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing ContractContact record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ContractContact-Edit role.

Enums

eContractContactType — ContractContactType values

Value	Name
0	None
1	Director
2	CompanyAlias
3	NominatedRecipient

eAmlCheckStatus — AmlCheckStatus values

Value	Name
0	NotStarted
1	Pending
2	Clear
3	PotentialMatch
4	ConfirmedMatch
5	Error
6	ManuallyCleared

Request Body

Required Fields

integer

required

The Id of the ContractContact record to update.

CoworkerContractId

integer

required

ID of the coworker contract linked to this record.

FullName

string

required

Full name of the contact. Used when the contact is not linked to a coworker record.

ContractContactType

integer

required

Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company).

AmlCheckStatus

integer

required

The AML check status for this contact.

Optional Fields

CoworkerId

integer

ID of the coworker linked to this record.

string

Email address of the contact. Used when the contact is not linked to a coworker record.

DateOfBirth

string

Date of birth. Used for identity verification purposes.

Address

string

Street address.

PostCode

string

Post code.

CityName

string

City name.

State

string

State or province.

CountryId

integer

ID of the country linked to this record.

PhoneNumber

string

Phone number.

Notes

string

Optional notes or comments about this contract contact.

AmlCheckDate

string

The date when the AML check was performed.

AmlOpenSanctionsScore

number

The score from the open sanctions check.

AmlOpenSanctionsResponse

string

The response from the open sanctions check as JSON string.

AmlPappersResponse

string

The response from the Pappers AML check as TEXT string.

AmlPappersStatus

string

The status from the Pappers AML check.

AmlNotes

string

Notes related to the AML check. Customers cannot see this field, it’s for internal use only.

AmlClearedBy

string

The user who cleared the AML check.

AmlClearedOn

string

The date when the AML check was cleared.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/contractcontacts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "FullName": "",
    "ContractContactType": 0,
    "AmlCheckStatus": 0,
    "Id": 87654321
}'

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the update.

Value

object

Contains the Id of the updated record.

WasSuccessful

boolean

true if the contractcontact was updated successfully.

Errors

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractContact was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message

string

A summary of the validation error(s), in the format PropertyName: error message.

Value

any

null on validation failure.

Errors

object[]

Array of validation errors.

Show child attributes

AttemptedValue

any

The value that was submitted for the field, or null if missing.

Message

string

The validation error message.

PropertyName

string

The name of the property that failed validation.

WasSuccessful

boolean

false when the request fails validation.

Example Response

{
  "Message": "FullName: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FullName"
    }
  ],
  "WasSuccessful": false
}

Delete ContractContactDelete an existing ContractContact record by its Id.

Update ContractContact

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/contractcontacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerContractId": 123,
  "FullName": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400