Update CoworkerTimePass

Update an existing CoworkerTimePass record.

PUT /api/billing/coworkertimepasses

Update CoworkerTimePass

cURL

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
}
'

200

{
  "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

Id · integer · required

The Id of the CoworkerTimePass record to update.

CoworkerId · integer · required

The customer who owns this time pass.

BusinessId · integer · required

The business (location) this time pass belongs to.

TimePassId · integer · required

The time pass definition this is an instance of.

CreateMultiple · integer · required

Number of time passes to create at once.

Optional Fields

Notes · string

Optional notes for this time pass.

PurchaseOrder · string

Purchase order reference.

Used · boolean

Whether this time pass has been used.

Free · boolean

Whether this time pass is free of charge.

Price · number

Custom price for this time pass.

ExpireDate · string

Expiration date for this time pass.

TariffTimePassUniqueId · string

Unique identifier linking this time pass to a tariff time pass allocation.

CoworkerProductUniqueId · string

Unique identifier linking this time pass to a customer product purchase.

CoworkerContractUniqueId · string

Unique identifier linking this time pass to a customer contract.

Code Examples

cURL

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
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the update.

Value · object

Contains the Id of the updated record.

WasSuccessful · boolean

true if the coworkertimepass was updated successfully.

Errors · 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": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

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

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

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

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · 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
}