Skip to main content
POST
/
api
/
billing
/
contractcontacts
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A ContractContact is a key contact entry on a virtual office contract (CoworkerContract). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract. Each entry can be linked to an existing coworker via CoworkerId, in which case the coworker’s name and email are resolved automatically. Alternatively, provide FullName and Email directly for contacts who do not have a coworker record. Use ContractContactType to classify the contact:
TypeDescription
DirectorA director of the company registered under the virtual office contract
CompanyAliasA trading name or alias used by the company
NominatedRecipientA person authorised to receive mail and deliveries on behalf of the company

​
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-Create role.

​
Enums

ValueName
0None
1Director
2CompanyAlias
3NominatedRecipient

​
Request Body

​
Required Fields

​
CoworkerContractId
integer
required
Coworker Contract Id.
​
FullName
string
required
Full name of the contact. Used when the contact is not linked to a coworker record.

​
Optional Fields

​
CoworkerId
integer
Coworker Id.
​
Email
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
Address.
​
PostCode
string
Post code.
​
CityName
string
City name.
​
State
string
State.
​
CountryId
integer
Country Id.
​
PhoneNumber
string
Phone number.
​
Notes
string
Notes.
​
ContractContactType
integer
Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). Defaults to eContractContactType.Director. See eContractContactType enum above.

​
Code Examples

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

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the contractcontact was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "ContractContact was successfully created.",
  "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.
​
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
}