Coworkers
Update Coworker
Update an existing Coworker record.
PUT
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
eCoworkerRecordType — CoworkerType values
eGender — Gender values
eGender — Gender values
eCoworkerTaxRateType — TaxRateType values
eCoworkerTaxRateType — TaxRateType values
eCoworkerAttendance — MondayAttendance values
eCoworkerAttendance — MondayAttendance values
eRegularPaymentProvider
eRegularPaymentProvider
Request Body
Required Fields
integer
required
The Id of the Coworker record to update.
integer
required
Whether this customer record represents an Individual or a Company..
string
required
Customer’s full name; required and limited to 254 characters..
integer
required
Optional customer gender: NotSet, Male, Female, Other, or RatherNotSay..
string
required
Customer email address; required by entity validation and used when creating an associated user account..
integer
required
ID of the customer’s contact country; global reference data and required by entity validation..
integer
required
ID of the customer’s time zone; global reference data and required by entity validation..
integer
required
Tax treatment for this customer: Default, Reduced, or Exempt..
integer
required
Expected Monday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Tuesday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Wednesday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Thursday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Friday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Saturday attendance: WorkingFromOffice or WorkingRemotely..
integer
required
Expected Sunday attendance: WorkingFromOffice or WorkingRemotely..
Optional Fields
integer[]
List of location IDs where this customer is registered; replacing the list replaces all registrations..
integer[]
IDs added to the Businesses relationship..
integer[]
IDs removed from the Businesses relationship..
integer[]
List of team IDs this customer belongs to; replacing the list replaces all team memberships..
integer[]
IDs added to the Teams relationship..
integer[]
IDs removed from the Teams relationship..
string
Optional preferred form of address, such as ‘Dr Adrian’; include how the customer wants to be addressed and never use a title alone, limited to 254 characters..
boolean
Whether to create the associated user account when this customer is first created; create-only..
string
URL of a new file to upload as the avatar.
boolean
Set to true to remove the current avatar file.
string
URL of a new file to upload as the banner image.
boolean
Set to true to remove the current banner image file.
string
Customer contact street address..
string
Customer contact postal or ZIP code, limited to 15 characters..
string
Customer contact city, limited to 50 characters..
string
Customer contact state, province, or region, limited to 255 characters..
string
Customer mobile telephone number, limited to 255 characters..
string
Customer landline or office telephone number, limited to 255 characters..
string
Optional customer date of birth..
string
Optional informal customer name, limited to 254 characters..
string
Customer’s professional sector or business area, limited to 254 characters..
string
Customer’s job title or role, limited to 254 characters..
string
Customer’s employer or company name..
string
Customer’s profile or company website URL, limited to 254 characters..
string
Customer profile tags as a text value, limited to 254 characters..
string
Customer’s public profile summary or biography, limited to 4,096 characters..
string
Customer’s Twitter profile or handle, limited to 254 characters..
string
Customer’s Facebook profile or handle, limited to 254 characters..
string
Customer’s Google profile or handle, limited to 254 characters..
string
Customer’s Telegram profile or handle, limited to 254 characters..
string
Customer’s LinkedIn profile or handle, limited to 254 characters..
string
Customer’s Skype profile or handle, limited to 254 characters..
string
Customer’s GitHub profile or handle, limited to 254 characters..
string
Customer’s Pinterest profile or handle, limited to 254 characters..
string
Customer’s Flickr profile or handle, limited to 254 characters..
string
Customer’s Instagram profile or handle, limited to 254 characters..
string
Customer’s Vimeo profile or handle, limited to 254 characters..
string
Customer’s Tumblr profile or handle, limited to 254 characters..
string
Customer’s Blogger profile or handle, limited to 254 characters..
boolean
Whether the customer’s profile is visible in the public member directory..
integer
ID of the location that owns this customer (their home location) and issues their invoices unless invoice split by location is enabled; defaults to the current location when omitted on create..
string
Email address to receive this customer’s invoices, limited to 254 characters..
string
Legal or trading name printed on invoices; when empty, invoices use the company name for Company customers or FullName otherwise..
string
Billing street address; when empty, invoices use the contact address..
string
Billing postal or ZIP code; when empty, invoices use the contact postal code..
string
Billing city; when empty, invoices use the contact city..
string
Billing state, province, or region; when empty, invoices use the contact state..
integer
ID of the country for invoice addresses; global reference data, with the contact country and then the location country used as fallbacks..
integer
ID of the time zone used for billing details; global reference data..
number
Optional non-negative tax percentage override for this customer..
string
Customer tax or VAT identification number, limited to 255 characters..
string
Bank name used for this customer’s regular-payment arrangement, limited to 255 characters..
string
Customer bank account identifier for a regular-payment arrangement; do not expose or set it through the agent..
string
Customer bank branch or sort code for a regular-payment arrangement; do not expose or set it through the agent..
boolean
Whether to notify the customer when a new invoice is created..
boolean
Whether to notify the customer when a payment is received..
boolean
Whether to notify the customer when an automatic payment fails..
boolean
Whether this customer can view invoices of their paying member when one exists..
boolean
Whether GoCardless regular payments are enabled for this customer..
boolean
Internal GoCardless Pro integration flag; managed by payment integration setup..
string
External GoCardless mandate or contract identifier; managed by the payment integration and not exposed to the agent..
string
Stripe BACS payment-method identifier; managed by the payment integration and not exposed to the agent..
string
Stripe BACS mandate identifier; managed by the payment integration and not exposed to the agent..
string
Stripe BACS customer token; security-sensitive integration credential not exposed to the agent..
boolean
Whether Stripe BACS direct-debit payments are enabled for this customer..
string
Timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent..
string
Timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent..
string
Internal referral tracking identifier; not exposed to the agent..
integer
Regular-payment provider selected for this customer; set by the supported payment flow rather than by manual provider assignment.. See
eRegularPaymentProvider? enum above.string
External regular-payment contract or mandate identifier managed by the payment provider..
string
Read-only last four digits of the customer’s payment card; supplied by the payment provider and not exposed to the agent..
boolean
Whether automatic invoice payment processing is disabled for this customer..
boolean
Whether this customer may check in through the network check-in integration..
string
Physical access-card identifier; managed through access control and not exposed to the agent..
string
Access-control PIN; security-sensitive and not exposed to the agent..
string
Physical access key-fob identifier; managed through access control and not exposed to the agent..
boolean
Whether to notify this customer about deliveries for their team..
string
External Ezeep user ID used by the printing integration..
boolean
Whether this customer can print for free through Ezeep..
string
External Ezeep Blue user ID used by the printing integration..
boolean
Whether this customer can print for free through Ezeep Blue..
boolean
Internal Ezeep Blue printing synchronization flag; managed by the integration..
boolean
Whether PaperCut pay-as-you-print is enabled for this customer..
boolean
Whether this customer can print for free through PaperCut..
string
External PaperCut user identifier used by the printing integration..
boolean
Whether this customer may make bookings..
boolean
Whether this customer may make bookings on behalf of their team..
boolean
Whether this customer may purchase products..
boolean
Whether this customer may purchase event tickets..
boolean
Whether this customer may access the community feature..
string
Optional external or internal reference number for this customer..
string
Optional free-text tag used to classify this customer..
string
Internal notes about this customer..
boolean
Whether an alert should be shown when staff open this customer’s record..
string
Alert message displayed to staff when ShowAlert is enabled..
integer
ID of the optional user account linked to this customer; update-only because creating the account uses CreateUser..
boolean
Whether this customer record is active..
string
Next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing..
integer
Optional number of days after issue date before this customer’s invoices are due..
string
Optional customer registration date..
boolean
Whether the customer has accepted the location’s general terms and conditions..
string
Timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent..
string
Timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent..
string
Optional custom customer field 1; its meaning is configured by the location..
string
Optional custom customer field 2; its meaning is configured by the location..
string
Optional custom customer field 3; its meaning is configured by the location..
string
Optional custom customer field 4; its meaning is configured by the location..
string
Optional custom customer field 5; its meaning is configured by the location..
string
Optional custom customer field 6; its meaning is configured by the location..
string
Optional custom customer field 7; its meaning is configured by the location..
string
Optional custom customer field 8; its meaning is configured by the location..
string
Optional custom customer field 9; its meaning is configured by the location..
string
Optional custom customer field 10; its meaning is configured by the location..
string
Optional custom customer field 11; its meaning is configured by the location..
string
Optional custom customer field 12; its meaning is configured by the location..
string
Optional custom customer field 13; its meaning is configured by the location..
string
Optional custom customer field 14; its meaning is configured by the location..
string
Optional custom customer field 15; its meaning is configured by the location..
string
Optional custom customer field 16; its meaning is configured by the location..
string
Optional custom customer field 17; its meaning is configured by the location..
string
Optional custom customer field 18; its meaning is configured by the location..
string
Optional custom customer field 19; its meaning is configured by the location..
string
Optional custom customer field 20; its meaning is configured by the location..
string
Optional custom customer field 21; its meaning is configured by the location..
string
Optional custom customer field 22; its meaning is configured by the location..
string
Optional custom customer field 23; its meaning is configured by the location..
string
Optional custom customer field 24; its meaning is configured by the location..
string
Optional custom customer field 25; its meaning is configured by the location..
string
Optional custom customer field 26; its meaning is configured by the location..
string
Optional custom customer field 27; its meaning is configured by the location..
string
Optional custom customer field 28; its meaning is configured by the location..
string
Optional custom customer field 29; its meaning is configured by the location..
string
Optional custom customer field 30; its meaning is configured by the location..
string
Localized invoice schedule value derived by the application; not exposed to the agent..
string
Localized next automatic-invoice value derived by the application; not exposed to the agent..
string
Localized registration-date value derived by the application; not exposed to the agent..
string
Internal access-control debounce timestamp; not exposed to the agent..
string
Microsoft 365 OAuth access token; security-sensitive credential not exposed to the agent..
string
Microsoft 365 OAuth refresh token; security-sensitive credential not exposed to the agent..
string
Zoom OAuth access token; security-sensitive credential not exposed to the agent..
string
Zoom OAuth refresh token; security-sensitive credential not exposed to the agent..
string
External Zoom user ID managed by the calendar integration..
string
Doordeck private key; security-sensitive credential not exposed to the agent..
string
Doordeck public key used by the access integration; not exposed through customer administration..
string
External Doordeck user ID managed by the access integration..
string
Microsoft 365 calendar subscription ID managed by the calendar integration..
string
Salto access-control token; security-sensitive credential not exposed to the agent..
string
Stripe ACH bank token; security-sensitive payment credential not exposed to the agent..
string
Stripe ACH customer token; security-sensitive payment credential not exposed to the agent..
boolean
Internal Stripe ACH agreement status; maintained by the payment flow and not exposed to the agent..
boolean
Internal Stripe ACH deposit-verification status; maintained by the payment flow and not exposed to the agent..
string
Optional purchase-order reference used for this customer’s billing..
boolean
Internal Square synchronization flag; maintained by the integration and not exposed to the agent..
string
Email address for delivery notifications, limited to 254 characters..
boolean
Internal marker that an access-control error notification was sent; not exposed to the agent..
boolean
Internal PaperCut synchronization marker; not exposed to the agent..
string
Google OAuth token; security-sensitive credential not exposed to the agent..
string
Google calendar subscription ID managed by the calendar integration..
boolean
Whether customer-specific invoice-segregation settings override the location-level settings..
boolean
Whether charges for contracts other than the main contract are invoiced separately from main-contract charges when invoice segregation is enabled..
boolean
Whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
boolean
Whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
boolean
Whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
boolean
Whether event-ticket charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
boolean
Whether this is the active customer profile when the linked user account has multiple customer profiles..
boolean
Whether one-off charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
integer
External Brivo access-control user ID managed by the integration..
boolean
Internal Ezeep printing synchronization flag; managed by the integration..
integer
Day of the month used to calculate the customer-specific invoice due date..
number
Optional geographic longitude for the contact address..
number
Optional geographic latitude for the contact address..
number
Optional geographic longitude for the billing address..
number
Optional geographic latitude for the billing address..
boolean
Whether this customer is archived..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the coworker was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response