Create Coworker

Create a new Coworker record.

POST /api/spaces/coworkers

Create Coworker

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerType": 123,
  "FullName": "<string>",
  "Gender": 123,
  "Email": "<string>",
  "CountryId": 123,
  "SimpleTimeZoneId": 123,
  "TaxRateType": 123,
  "MondayAttendance": 123,
  "TuesdayAttendance": 123,
  "WednesdayAttendance": 123,
  "ThursdayAttendance": 123,
  "FridayAttendance": 123,
  "SaturdayAttendance": 123,
  "SundayAttendance": 123
}
'

200

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

A Coworker represents a customer in Nexudus. Coworkers can be individuals or companies and hold all personal, billing, access-control, and plan information for a customer.

When creating a coworker, set CreateUser to grant portal and app access — this also sends a welcome email with access details.

To assign a plan at creation time, pass TariffId with the plan ID. Combine with BillingDay to fix the billing day (defaults to the current day or the plan’s default billing day) and RenewalDate to set the date when the plan starts and will first be invoiced.

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

Enums

eCoworkerRecordType — CoworkerType values

Value	Name
1	Individual
2	Company

eGender — Gender values

Value	Name
0	None
1	NotSet
2	Male
3	Female
4	Other
5	RatherNotSay

eCoworkerTaxRateType — TaxRateType values

Value	Name
1	Default
2	Reduced
3	Exempt

eCoworkerAttendance — MondayAttendance values

Value	Name
1	WorkingFromOffice
2	WorkingFromHome
3	WorkingFromAbroad
4	NotWorking
5	Undefined

eRegularPaymentProvider

Value	Name
0	None
1	MultiGateway
2	Stripe
3	Forte
4	AuthorizeNetSubscription
5	PaypalStandardSubscription
6	PayPalAdaptive
7	EPay
8	Braintree
9	EziDebit
10	LiqPay
11	StripeACH
12	GoCardless
13	StripeBACS
94	CreditNote
95	GiftCard
96	BankTransfer
97	Cash
98	Check
99	Other

Request Body

Required Fields

CoworkerType · integer · required

Coworker type. Defaults to eCoworkerRecordType.Individual.

FullName · string · required

Full name.

Gender · integer · required

Gender of the person. Defaults to eGender.NotSet.

Email · string · required

Email address.

CountryId · integer · required

ID of the country linked to this record.

SimpleTimeZoneId · integer · required

ID of the simple time zone linked to this record.

TaxRateType · integer · required

Tax rate type. Defaults to eCoworkerTaxRateType.Default.

MondayAttendance · integer · required

Monday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

TuesdayAttendance · integer · required

Tuesday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

WednesdayAttendance · integer · required

Wednesday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

ThursdayAttendance · integer · required

Thursday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

FridayAttendance · integer · required

Friday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

SaturdayAttendance · integer · required

Saturday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

SundayAttendance · integer · required

Sunday attendance. Defaults to eCoworkerAttendance.WorkingFromOffice.

Optional Fields

Businesses · integer[]

List of businesses linked to this record.

Teams · integer[]

List of teams linked to this record.

Salutation · string

Title or salutation prefix (e.g. Mr, Mrs, Dr).

CreateUser · boolean

Create user account. Grants portal and app access and sends a welcome email with the access details.

NewAvatarUrl · string

URL of a new file to upload as the avatar.

ClearAvatarFile · boolean

Set to true to remove the current avatar file.

NewBannerImageUrl · string

URL of a new file to upload as the banner image.

ClearBannerImageFile · boolean

Set to true to remove the current banner image file.

Address · string

Street address.

PostCode · string

Post code.

CityName · string

City name.

State · string

State or province.

MobilePhone · string

Mobile phone.

LandLine · string

Land line.

DateOfBirth · string

Date of birth.

NickName · string

Nickname.

BusinessArea · string

Business area.

Position · string

Display order position or job title.

CompanyName · string

Company name.

ProfileWebsite · string

Profile website.

ProfileTags · string

Profile tags.

ProfileSummary · string

Profile summary.

Twitter · string

Twitter handle.

Facebook · string

Facebook profile.

Google · string

The google value for this coworker.

Telegram · string

Telegram handle.

Linkedin · string

LinkedIn profile.

Skype · string

Skype handle.

Github · string

GitHub profile.

Pinterest · string

The pinterest value for this coworker.

Flickr · string

The flickr value for this coworker.

Instagram · string

Instagram profile.

Vimeo · string

The vimeo value for this coworker.

Tumblr · string

The tumblr value for this coworker.

Blogger · string

The blogger value for this coworker.

ProfileIsPublic · boolean

Profile is public.

InvoicingBusinessId · integer

ID of the invoicing business linked to this record.

BillingEmail · string

Billing email.

BillingName · string

Billing name.

BillingAddress · string

Billing address.

BillingPostCode · string

Billing post code.

BillingCityName · string

Billing city.

BillingState · string

Billing state.

BillingCountryId · integer

ID of the billing country linked to this record.

BillingSimpleTimeZoneId · integer

ID of the billing simple time zone linked to this record.

TaxRate · number

Tax rate.

TaxIDNumber · string

Tax ID number.

BankName · string

Bank name.

BankAccount · string

Bank account.

BankBranch · string

Bank branch.

NotifyOnNewInvoice · boolean

Notify on new invoice.

NotifyOnNewPayment · boolean

Notify on new payment.

NotifyOnFailedPayment · boolean

Notify on failed payment.

ShowPayingMemberInvoices · boolean

Show paying member invoices.

EnableGoCardlessPayments · boolean

Enable GoCardless payments.

UseGoCardlessProPayments · boolean

Whether use go cardless pro payments is enabled.

GoCardlessContractNumber · string

GoCardless contract number.

StripeBacsDDPaymentMethodId · string

ID of the stripe bacs dd payment method associated with this record.

StripeBacsDDMandateId · string

ID of the stripe bacs dd mandate associated with this record.

StripeBacsDDCustomerToken · string

The stripe bacs dd customer token value for this coworker.

StripeBacsDDEnabled · boolean

Whether stripe bacs dd enabled is enabled.

LastOverDueInvoiceReminder · string

Date/time value for last over due invoice reminder.

LastLowCreditReminder · string

Date/time value for last low credit reminder.

RefererGuid · string

Unique identifier (GUID) for the referer.

RegularPaymentProvider · integer

Regular payment provider. See eRegularPaymentProvider? enum above.

RegularPaymentContractNumber · string

Regular payment contract number.

DoNotProcessInvoicesAutomatically · boolean

Do not process invoices automatically.

AllowNetworkCheckin · boolean

Allow network check-in.

AccessCardId · string

Access card ID.

AccessPincode · string

Access PIN code.

KeyFobNumber · string

Key fob number.

NotifyOnDelivery · boolean

Notify on delivery.

EzeepUserId · string

ID of the ezeep user associated with this record.

EzeepFreePrinting · boolean

Whether ezeep free printing is enabled.

EzeepBlueUserId · string

ID of the ezeep blue user associated with this record.

EzeepBlueFreePrinting · boolean

Whether ezeep blue free printing is enabled.

EzeepBluePrintingEnabled · boolean

Whether ezeep blue printing enabled is enabled.

PaperCutPayAsYouPrint · boolean

Whether paper cut pay as you print is enabled.

PaperCutFreePrinting · boolean

Whether paper cut free printing is enabled.

PaperCutUserId · string

ID of the paper cut user associated with this record.

CanMakeBookings · boolean

Can make bookings.

CanBookForTeam · boolean

Can book for team.

CanPurchaseProducts · boolean

Can purchase products.

CanPurchaseEvents · boolean

Can purchase events.

CanAccessCommunity · boolean

Can access community.

ReferenceNumber · string

Reference number.

Tag · string

Free-form tag for categorising or filtering.

Notes · string

Optional notes or comments about this coworker.

ShowAlert · boolean

Show alert.

AlertNote · string

Alert note.

UserId · integer

ID of the user linked to this record.

Active · boolean

Whether this coworker is currently active.

NextAutoInvoice · string

Next auto invoice date.

InvoiceDueDatePeriod · integer

Invoice due date period.

RegistrationDate · string

Registration date.

GeneralTermsAccepted · boolean

General terms accepted.

LastRenewal · string

Date/time value for last renewal.

LastInvoiceAttempt · string

Date/time value for last invoice attempt.

Custom1 · string

Custom field 1.

Custom2 · string

Custom field 2.

Custom3 · string

Custom field 3.

Custom4 · string

Custom field 4.

Custom5 · string

Custom field 5.

Custom6 · string

Custom field 6.

Custom7 · string

Custom field 7.

Custom8 · string

Custom field 8.

Custom9 · string

Custom field 9.

Custom10 · string

Custom field 10.

Custom11 · string

Custom field 11.

Custom12 · string

Custom field 12.

Custom13 · string

Custom field 13.

Custom14 · string

Custom field 14.

Custom15 · string

Custom field 15.

Custom16 · string

Custom field 16.

Custom17 · string

Custom field 17.

Custom18 · string

Custom field 18.

Custom19 · string

Custom field 19.

Custom20 · string

Custom field 20.

Custom21 · string

Custom field 21.

Custom22 · string

Custom field 22.

Custom23 · string

Custom field 23.

Custom24 · string

Custom field 24.

Custom25 · string

Custom field 25.

Custom26 · string

Custom field 26.

Custom27 · string

Custom field 27.

Custom28 · string

Custom field 28.

Custom29 · string

Custom field 29.

Custom30 · string

Custom field 30.

NextInvoiceLocal · string

Date/time value for next invoice local.

NextAutoInvoiceLocal · string

Date/time value for next auto invoice local.

RegistrationDateLocal · string

Date/time value for registration date local.

AccessControlDebounceTime · string

Date/time value for access control debounce time.

Office365AccessToken · string

The office365 access token value for this coworker.

Office365RefreshToken · string

The office365 refresh token value for this coworker.

ZoomAccessToken · string

The zoom access token value for this coworker.

ZoomRefreshToken · string

The zoom refresh token value for this coworker.

ZoomUserId · string

ID of the zoom user associated with this record.

DoordeckPrivateKey · string

The doordeck private key value for this coworker.

DoordeckPublicKey · string

The doordeck public key value for this coworker.

DoordeckUserGuid · string

Unique identifier (GUID) for the doordeck user.

Office365SubscriptionId · string

ID of the office365 subscription associated with this record.

SaltoV2AccessToken · string

The salto v2 access token value for this coworker.

StripeACHBankToken · string

The stripe ach bank token value for this coworker.

StripeACHCustomerToken · string

The stripe ach customer token value for this coworker.

HasAcceptedStripeACHAgreement · boolean

Whether has accepted stripe ach agreement is enabled.

HasVerifiedStripeACHDeposits · boolean

Whether has verified stripe ach deposits is enabled.

PurchaseOrder · string

Purchase order.

SyncToSquare · boolean

Whether sync to square is enabled.

NotifyOnDeliveriesEmail · string

Notify on deliveries email.

AccessControlErrorNotificationSent · boolean

Whether access control error notification sent is enabled.

SyncToPaperCutDue · boolean

Whether sync to paper cut due is enabled.

GoogleApiToken · string

The google api token value for this coworker.

GoogleSubscriptionId · string

ID of the google subscription associated with this record.

InvoiceSegregationOverride · boolean

Whether invoice segregation override is enabled.

InvoiceSegregateContracts · boolean

Whether invoice segregate contracts is enabled.

InvoiceSegregateBookings · boolean

Whether invoice segregate bookings is enabled.

InvoiceSegregateProducts · boolean

Whether invoice segregate products is enabled.

InvoiceSegregateTimePasses · boolean

Whether invoice segregate time passes is enabled.

InvoiceSegregateTickets · boolean

Whether invoice segregate tickets is enabled.

IsDefaultProfile · boolean

Whether is default profile is enabled.

InvoiceSegregateCharges · boolean

Whether invoice segregate charges is enabled.

BrivoUserId · integer

ID of the brivo user associated with this record.

EzeepPrintingEnabled · boolean

Whether ezeep printing enabled is enabled.

InvoiceDueDateDay · integer

The invoice due date day value for this coworker.

Longitude · number

GPS longitude coordinate.

Latitude · number

GPS latitude coordinate.

BillingLongitude · number

Billing longitude.

BillingLatitude · number

Billing latitude.

Archived · boolean

Whether this coworker is archived and hidden from active lists.

Code Examples

cURL

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerType": 0,
    "FullName": "",
    "Gender": 0,
    "Email": "",
    "CountryId": 0,
    "SimpleTimeZoneId": 0,
    "TaxRateType": 0,
    "MondayAttendance": 0,
    "TuesdayAttendance": 0,
    "WednesdayAttendance": 0,
    "ThursdayAttendance": 0,
    "FridayAttendance": 0,
    "SaturdayAttendance": 0,
    "SundayAttendance": 0
}'

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 coworker was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Coworker was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "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": "CoworkerType: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CoworkerType"
    }
  ],
  "WasSuccessful": false
}