Update TimePass

PUT

api

billing

timepasses

Update TimePass

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/timepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "Price": 123,
  "CurrencyId": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "Price": 123,
    "CurrencyId": 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, BusinessId: 123, Name: '<string>', Price: 123, CurrencyId: 123})
};

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

Request Body

Required Fields

integer

required

The Id of the TimePass record to update.

integer

required

ID of the business linked to this record.

string

required

Time pass name.

number

required

Unit price amount.

integer

required

ID of the currency linked to this record.

Optional Fields

string

Invoice line display text.

integer

Minutes included.

boolean

Counts towards plan limits.

boolean

Use as pay-as-you-go for members.

boolean

Use as pay-as-you-go for contacts.

integer

Use priority.

integer

ID of the tax rate linked to this record.

integer

ID of the reduced tax rate linked to this record.

integer

ID of the exempt tax rate linked to this record.

integer

ID of the financial account linked to this record.

integer[]

List of businesses linked to this record.

integer[]

The added businesses value for this time pass.

integer[]

The removed businesses value for this time pass.

string

Kisi group ID.

string

DoorGuard group ID.

string

ID of the access control group associated with this record.

boolean

Allow network check-in.

boolean

Only available for contacts.

boolean

Only available for members.

integer[]

List of tariffs linked to this record.

integer[]

The added tariffs value for this time pass.

integer[]

The removed tariffs value for this time pass.

boolean

Whether this time pass is archived and hidden from active lists.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/timepasses',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Price': 0,
        'CurrencyId': 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 timepass was updated successfully.

array

null on success.

Example Response

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

Delete TimePassDelete an existing TimePass record by its Id.

Update TimePass

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/timepasses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "Price": 123,
  "CurrencyId": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "Price": 123,
    "CurrencyId": 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, BusinessId: 123, Name: '<string>', Price: 123, CurrencyId: 123})
};

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