Update Coworker

Updates an existing Coworker 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 Coworker-Edit 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

integer

required

The Id of the Coworker record to update.

FullName

string

required

Full name.

string

required

Email address.

CountryId

integer

required

Country Id.

SimpleTimeZoneId

integer

required

Simple Time Zone Id.

Optional Fields

CoworkerType

integer

Coworker type. See eCoworkerRecordType enum above.

Businesses

integer[]

Businesses.

AddedBusinesses

integer[]

Added Businesses.

RemovedBusinesses

integer[]

Removed Businesses.

Teams

integer[]

Teams.

AddedTeams

integer[]

Added Teams.

RemovedTeams

integer[]

Removed Teams.

Salutation

string

Salutation.

Gender

integer

Gender. See eGender enum above.

CreateUser

boolean

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

NewAvatarUrl

string

New Avatar Url.

ClearAvatarFile

boolean

Clear Avatar File.

NewBannerImageUrl

string

New Banner Image Url.

ClearBannerImageFile

boolean

Clear Banner Image File.

Address

string

Address.

PostCode

string

Post code.

CityName

string

City name.

State

string

State.

MobilePhone

string

Mobile phone.

LandLine

string

Land line.

DateOfBirth

string

Date of birth.

NickName

string

Nickname.

BusinessArea

string

Business area.

Position

string

Position.

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

Google.

string

Telegram handle.

string

LinkedIn profile.

Skype

string

Skype handle.

Github

string

GitHub profile.

string

Pinterest.

Flickr

string

Flickr.

Instagram

string

Instagram profile.

Vimeo

string

Vimeo.

Tumblr

string

Tumblr.

Blogger

string

Blogger.

ProfileIsPublic

boolean

Profile is public.

InvoicingBusinessId

integer

Invoicing Business Id.

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

Billing Country Id.

BillingSimpleTimeZoneId

integer

Billing Simple Time Zone Id.

TaxRateType

integer

Tax rate type. See eCoworkerTaxRateType enum above.

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

Use Go Cardless Pro Payments.

GoCardlessContractNumber

string

GoCardless contract number.

StripeBacsDDPaymentMethodId

string

Stripe Bacs DDPayment Method Id.

StripeBacsDDMandateId

string

Stripe Bacs DDMandate Id.

StripeBacsDDCustomerToken

string

Stripe Bacs DDCustomer Token.

StripeBacsDDEnabled

boolean

Stripe Bacs DDEnabled.

LastOverDueInvoiceReminder

string

Last Over Due Invoice Reminder.

LastLowCreditReminder

string

Last Low Credit Reminder.

RefererGuid

string

Referer Guid.

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

Ezeep User Id.

EzeepFreePrinting

boolean

Ezeep Free Printing.

EzeepBlueUserId

string

Ezeep Blue User Id.

EzeepBlueFreePrinting

boolean

Ezeep Blue Free Printing.

EzeepBluePrintingEnabled

boolean

Ezeep Blue Printing Enabled.

PaperCutPayAsYouPrint

boolean

Paper Cut Pay As You Print.

PaperCutFreePrinting

boolean

Paper Cut Free Printing.

PaperCutUserId

string

Paper Cut User Id.

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

Tag.

Notes

string

Notes.

ShowAlert

boolean

Show alert.

AlertNote

string

Alert note.

UserId

integer

User Id.

Active

boolean

Active.

NextAutoInvoice

string

Next auto invoice date.

InvoiceDueDatePeriod

integer

Invoice due date period.

RegistrationDate

string

Registration date.

GeneralTermsAccepted

boolean

General terms accepted.

LastRenewal

string

Last Renewal.

LastInvoiceAttempt

string

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

Next Invoice Local.

NextAutoInvoiceLocal

string

Next Auto Invoice Local.

RegistrationDateLocal

string

Registration Date Local.

AccessControlDebounceTime

string

Access Control Debounce Time.

Office365AccessToken

string

Office365Access Token.

Office365RefreshToken

string

Office365Refresh Token.

ZoomAccessToken

string

Zoom Access Token.

ZoomRefreshToken

string

Zoom Refresh Token.

ZoomUserId

string

Zoom User Id.

DoordeckPrivateKey

string

Doordeck Private Key.

DoordeckPublicKey

string

Doordeck Public Key.

DoordeckUserGuid

string

Doordeck User Guid.

Office365SubscriptionId

string

Office365Subscription Id.

SaltoV2AccessToken

string

Salto V2Access Token.

StripeACHBankToken

string

Stripe ACHBank Token.

StripeACHCustomerToken

string

Stripe ACHCustomer Token.

HasAcceptedStripeACHAgreement

boolean

Has Accepted Stripe ACHAgreement.

HasVerifiedStripeACHDeposits

boolean

Has Verified Stripe ACHDeposits.

PurchaseOrder

string

Purchase order.

SyncToSquare

boolean

Sync To Square.

NotifyOnDeliveriesEmail

string

Notify on deliveries email.

AccessControlErrorNotificationSent

boolean

Access Control Error Notification Sent.

SyncToPaperCutDue

boolean

Sync To Paper Cut Due.

GoogleApiToken

string

Google Api Token.

GoogleSubscriptionId

string

Google Subscription Id.

InvoiceSegregationOverride

boolean

Invoice Segregation Override.

InvoiceSegregateContracts

boolean

Invoice Segregate Contracts.

InvoiceSegregateBookings

boolean

Invoice Segregate Bookings.

InvoiceSegregateProducts

boolean

Invoice Segregate Products.

InvoiceSegregateTimePasses

boolean

Invoice Segregate Time Passes.

InvoiceSegregateTickets

boolean

Invoice Segregate Tickets.

IsDefaultProfile

boolean

Is Default Profile.

InvoiceSegregateCharges

boolean

Invoice Segregate Charges.

BrivoUserId

integer

Brivo User Id.

EzeepPrintingEnabled

boolean

Ezeep Printing Enabled.

InvoiceDueDateDay

integer

Invoice Due Date Day.

MondayAttendance

integer

Monday attendance. See eCoworkerAttendance enum above.

TuesdayAttendance

integer

Tuesday attendance. See eCoworkerAttendance enum above.

WednesdayAttendance

integer

Wednesday attendance. See eCoworkerAttendance enum above.

ThursdayAttendance

integer

Thursday attendance. See eCoworkerAttendance enum above.

FridayAttendance

integer

Friday attendance. See eCoworkerAttendance enum above.

SaturdayAttendance

integer

Saturday attendance. See eCoworkerAttendance enum above.

SundayAttendance

integer

Sunday attendance. See eCoworkerAttendance enum above.

Longitude

number

Longitude.

Latitude

number

Latitude.

BillingLongitude

number

Billing longitude.

BillingLatitude

number

Billing latitude.

Archived

boolean

Archived.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/spaces/coworkers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FullName": "",
    "Email": "",
    "CountryId": 0,
    "SimpleTimeZoneId": 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 coworker was updated successfully.

Errors

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Coworker 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
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​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