Update CoworkerExtraService

PUT

api

billing

coworkerextraservices

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerextraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "TotalUses": 123,
  "ChargePeriod": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "ExtraServiceId": 123,
    "TotalUses": 123,
    "ChargePeriod": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CoworkerId: 123,
    BusinessId: 123,
    ExtraServiceId: 123,
    TotalUses: 123,
    ChargePeriod: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Updates an existing CoworkerExtraService 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 CoworkerExtraService-Edit role.

Enums

eChargePeriod — ChargePeriod values

Value	Name
1	Minutes
2	Days
3	Weeks
4	Months
5	Uses
6	FourWeekMonths

Request Body

Required Fields

integer

required

The Id of the CoworkerExtraService record to update.

integer

required

ID of the customer who owns this time credit or booking charge..

integer

required

ID of the location that issued this record; it is required and cannot be changed after creation..

integer

required

ID of the booking rate that defines this record’s eligible resource types, currency, and credit type..

integer

required

Total credit granted, in the ChargePeriod unit; it must be at least RemainingUses and is set only when creating a manual credit..

integer

required

Unit used for TotalUses and RemainingUses: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths..

Optional Fields

string

Optional internal notes about this time credit or booking charge..

boolean

Whether the record has no charge to the customer; when true, calculated price is zero..

number

Optional monetary amount charged in the booking rate’s currency; when omitted, the server calculates it from the rate and TotalUses..

string

Optional UTC date and time when credit becomes usable; blank means it can be used immediately..

string

Optional UTC expiry date and time; blank means no expiry, and when set it must be after ValidFrom and credit is valid only before it..

string

Optional UTC due date for invoicing this booking charge; blank means it is included on the next invoice..

string

Optional customer purchase-order reference for invoicing..

boolean

Whether to invoice this customer directly rather than their team or company paying customer..

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/coworkerextraservices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "ExtraServiceId": 0,
    "TotalUses": 0,
    "ChargePeriod": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      ExtraServiceId: 0,
      TotalUses: 0,
      ChargePeriod: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'ExtraServiceId': 0,
        'TotalUses': 0,
        'ChargePeriod': 0,
        'Id': 87654321
    }
)

data = response.json()

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 coworkerextraservice was updated successfully.

array

null on success.

Example Response

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "ChargePeriod: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ChargePeriod"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerExtraService

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerextraservices \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "TotalUses": 123,
  "ChargePeriod": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerextraservices"

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "ExtraServiceId": 123,
    "TotalUses": 123,
    "ChargePeriod": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CoworkerId: 123,
    BusinessId: 123,
    ExtraServiceId: 123,
    TotalUses: 123,
    ChargePeriod: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerextraservices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400