Update CoworkerProduct

PUT

api

billing

coworkerproducts

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerproducts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "ProductId": 123,
  "Quantity": 123,
  "RepeatCycle": 123,
  "CreditAmount": 123,
  "DiscountAmount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "ProductId": 123,
    "Quantity": 123,
    "RepeatCycle": 123,
    "CreditAmount": 123,
    "DiscountAmount": 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,
    ProductId: 123,
    Quantity: 123,
    RepeatCycle: 123,
    CreditAmount: 123,
    DiscountAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerproducts', 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 CoworkerProduct 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 CoworkerProduct-Edit role.

Enums

eRecurrentChargePattern — RepeatCycle values

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Request Body

Required Fields

integer

required

The Id of the CoworkerProduct record to update.

integer

required

ID of the coworker linked to this record.

integer

required

ID of the business linked to this record.

integer

required

ID of the product linked to this record.

integer

required

Number of units.

integer

required

Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan.

number

required

Credit amount.

number

required

Discount amount.

Optional Fields

string

Optional notes or comments about this coworker product.

string

Purchase order.

boolean

Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.

boolean

Invoice this customer for this product instead of the paying member of their team.

number

Price override.

boolean

Whether this is a regular charge.

integer

Number of repeat units.

string

Invoice on date.

string

Repeat from date.

string

Repeat until date.

string

Sale date.

string

Due date.

boolean

Whether it has been invoiced.

boolean

Whether mrm reminded is enabled.

boolean

Apply pro-rating.

string

ID of the proposal unique associated with this record.

integer

Coworker invoice ID.

string

Coworker invoice number.

boolean

Whether coworker invoice is paid.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/coworkerproducts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "ProductId": 0,
    "Quantity": 0,
    "RepeatCycle": 0,
    "CreditAmount": 0,
    "DiscountAmount": 0,
    "Id": 87654321
}'

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

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/coworkerproducts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'ProductId': 0,
        'Quantity': 0,
        'RepeatCycle': 0,
        'CreditAmount': 0,
        'DiscountAmount': 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 coworkerproduct was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerProduct 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": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}

Delete CoworkerProductDelete an existing CoworkerProduct record by its Id.

Update CoworkerProduct

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerproducts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "ProductId": 123,
  "Quantity": 123,
  "RepeatCycle": 123,
  "CreditAmount": 123,
  "DiscountAmount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "ProductId": 123,
    "Quantity": 123,
    "RepeatCycle": 123,
    "CreditAmount": 123,
    "DiscountAmount": 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,
    ProductId: 123,
    Quantity: 123,
    RepeatCycle: 123,
    CreditAmount: 123,
    DiscountAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerproducts', 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