Update CoworkerTimePass

PUT

api

billing

coworkertimepasses

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

import requests

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

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "TimePassId": 123,
    "CreateMultiple": 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,
    TimePassId: 123,
    CreateMultiple: 123
  })
};

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

Request Body

Required Fields

integer

required

The Id of the CoworkerTimePass record to update.

integer

required

ID of the customer assigned this pass.

integer

required

ID of the location that owns this pass.

integer

required

ID of the pass definition to issue; it determines the included number of uses and default price.

integer

required

Number of identical passes to issue in this request, including this one; a customer cannot hold more than 500 passes.

Optional Fields

string

Optional internal notes about this issued pass.

string

Optional purchase-order reference for this pass.

boolean

Whether the customer has used this pass; update-only operational status.

boolean

Whether no charge is due for this issued pass; when true its calculated price is zero.

number

Optional monetary price override for this issued pass; when omitted, the selected pass calculates the price for the customer.

string

Optional UTC expiration date and time; an expired pass is excluded from access-control updates.

string

Internal GUID linking this pass to the plan allocation that created it; do not set or use this field.

string

Internal GUID linking this pass to the customer product purchase that created it; do not set or use this field.

string

Internal GUID linking this pass to the customer contract that created it; do not set or use this field.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'TimePassId': 0,
        'CreateMultiple': 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 coworkertimepass was updated successfully.

array

null on success.

Example Response

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

Update CoworkerTimePass

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

import requests

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

payload = {
    "Id": 123,
    "CoworkerId": 123,
    "BusinessId": 123,
    "TimePassId": 123,
    "CreateMultiple": 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,
    TimePassId: 123,
    CreateMultiple: 123
  })
};

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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400