Coworkers
Create Coworker
Create a new Coworker record.
POST
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
eCoworkerRecordType — CoworkerType values
| Value | Name |
|---|---|
| 1 | Individual |
| 2 | Company |
eGender — Gender values
eGender — Gender values
| Value | Name |
|---|---|
| 0 | None |
| 1 | NotSet |
| 2 | Male |
| 3 | Female |
| 4 | Other |
| 5 | RatherNotSay |
eCoworkerTaxRateType — TaxRateType values
eCoworkerTaxRateType — TaxRateType values
| Value | Name |
|---|---|
| 1 | Default |
| 2 | Reduced |
| 3 | Exempt |
eCoworkerAttendance — MondayAttendance values
eCoworkerAttendance — MondayAttendance values
| Value | Name |
|---|---|
| 1 | WorkingFromOffice |
| 2 | WorkingFromHome |
| 3 | WorkingFromAbroad |
| 4 | NotWorking |
| 5 | Undefined |
eRegularPaymentProvider
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
Full name.
Email address.
Country Id.
Simple Time Zone Id.
Optional Fields
Coworker type. Defaults to
eCoworkerRecordType.Individual. See eCoworkerRecordType enum above.Businesses.
Teams.
Salutation.
Gender. Defaults to
eGender.NotSet. See eGender enum above.Create user account. Grants portal and app access and sends a welcome email with the access details.
New Avatar Url.
Clear Avatar File.
New Banner Image Url.
Clear Banner Image File.
Address.
Post code.
City name.
State.
Mobile phone.
Land line.
Date of birth.
Nickname.
Business area.
Position.
Company name.
Profile website.
Profile tags.
Profile summary.
Twitter handle.
Facebook profile.
Google.
Telegram handle.
LinkedIn profile.
Skype handle.
GitHub profile.
Pinterest.
Flickr.
Instagram profile.
Vimeo.
Tumblr.
Blogger.
Profile is public.
Invoicing Business Id.
Billing email.
Billing name.
Billing address.
Billing post code.
Billing city.
Billing state.
Billing Country Id.
Billing Simple Time Zone Id.
Tax rate type. Defaults to
eCoworkerTaxRateType.Default. See eCoworkerTaxRateType enum above.Tax rate.
Tax ID number.
Bank name.
Bank account.
Bank branch.
Notify on new invoice.
Notify on new payment.
Notify on failed payment.
Show paying member invoices.
Enable GoCardless payments.
Use Go Cardless Pro Payments.
GoCardless contract number.
Stripe Bacs DDPayment Method Id.
Stripe Bacs DDMandate Id.
Stripe Bacs DDCustomer Token.
Stripe Bacs DDEnabled.
Last Over Due Invoice Reminder.
Last Low Credit Reminder.
Referer Guid.
Regular payment provider. See
eRegularPaymentProvider? enum above.Regular payment contract number.
Do not process invoices automatically.
Allow network check-in.
Access card ID.
Access PIN code.
Key fob number.
Notify on delivery.
Ezeep User Id.
Ezeep Free Printing.
Ezeep Blue User Id.
Ezeep Blue Free Printing.
Ezeep Blue Printing Enabled.
Paper Cut Pay As You Print.
Paper Cut Free Printing.
Paper Cut User Id.
Can make bookings.
Can book for team.
Can purchase products.
Can purchase events.
Can access community.
Reference number.
Tag.
Notes.
Show alert.
Alert note.
User Id.
Active.
Next auto invoice date.
Invoice due date period.
Registration date.
General terms accepted.
Last Renewal.
Last Invoice Attempt.
Custom field 1.
Custom field 2.
Custom field 3.
Custom field 4.
Custom field 5.
Custom field 6.
Custom field 7.
Custom field 8.
Custom field 9.
Custom field 10.
Custom field 11.
Custom field 12.
Custom field 13.
Custom field 14.
Custom field 15.
Custom field 16.
Custom field 17.
Custom field 18.
Custom field 19.
Custom field 20.
Custom field 21.
Custom field 22.
Custom field 23.
Custom field 24.
Custom field 25.
Custom field 26.
Custom field 27.
Custom field 28.
Custom field 29.
Custom field 30.
Next Invoice Local.
Next Auto Invoice Local.
Registration Date Local.
Access Control Debounce Time.
Office365Access Token.
Office365Refresh Token.
Zoom Access Token.
Zoom Refresh Token.
Zoom User Id.
Doordeck Private Key.
Doordeck Public Key.
Doordeck User Guid.
Office365Subscription Id.
Salto V2Access Token.
Stripe ACHBank Token.
Stripe ACHCustomer Token.
Has Accepted Stripe ACHAgreement.
Has Verified Stripe ACHDeposits.
Purchase order.
Sync To Square.
Notify on deliveries email.
Access Control Error Notification Sent.
Sync To Paper Cut Due.
Google Api Token.
Google Subscription Id.
Invoice Segregation Override.
Invoice Segregate Contracts.
Invoice Segregate Bookings.
Invoice Segregate Products.
Invoice Segregate Time Passes.
Invoice Segregate Tickets.
Is Default Profile.
Invoice Segregate Charges.
Brivo User Id.
Ezeep Printing Enabled.
Invoice Due Date Day.
Monday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Tuesday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Wednesday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Thursday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Friday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Saturday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Sunday attendance. Defaults to
eCoworkerAttendance.WorkingFromOffice. See eCoworkerAttendance enum above.Longitude.
Latitude.
Billing longitude.
Billing latitude.
Archived.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coworker was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response