Run command for TimePasses

POST

api

billing

timepasses

runcommand

Run command for TimePasses

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/timepasses/runcommand \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "<string>",
  "Ids": [
    123
  ]
}
'

import requests

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

payload = {
    "Key": "<string>",
    "Ids": [123]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Key: '<string>', Ids: [123]})
};

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

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

Executes a command on one or more TimePass records. Use the Commands endpoint to discover available commands and their required parameters.

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-Update role.

Request Body

string

required

The command key to execute. Obtain available keys from the Commands endpoint.

integer[]

required

List of TimePass record Ids to execute the command on.

object[]

If the command requires parameters, provide them as an array of objects with Name and Value fields.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/timepasses/runcommand" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Key": "COMMAND_KEY_1",
    "Ids": [87654321, 87654322],
    "Parameters": [
      {
        "Name": "Parameter name",
        "Value": "Parameter value"
      }
    ]
  }'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/timepasses/runcommand',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      Key: 'COMMAND_KEY_1',
      Ids: [87654321, 87654322],
      Parameters: [
        {
          Name: 'Parameter name',
          Value: 'Parameter value'
        }
      ]
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/timepasses/runcommand',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'Key': 'COMMAND_KEY_1',
        'Ids': [87654321, 87654322],
        'Parameters': [
            {
                'Name': 'Parameter name',
                'Value': 'Parameter value'
            }
        ]
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the command was executed.

object

Contains details about the command execution result.

boolean

true if the command was executed successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "The command was run correctly.",
  "Value": null,
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

Search TimePassPricesSearch and list TimePassPrice records with filtering, sorting, and pagination.

Run command for TimePasses

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/timepasses/runcommand \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "<string>",
  "Ids": [
    123
  ]
}
'

import requests

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

payload = {
    "Key": "<string>",
    "Ids": [123]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Key: '<string>', Ids: [123]})
};

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

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Code Examples

Response

200

​Authentication

​Request Body

​Code Examples

​Response

​200

Authentication

Request Body

Code Examples

Response

200