Update Checkin

PUT

api

spaces

checkins

Update Checkin

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

import requests

url = "https://spaces.nexudus.com/api/spaces/checkins"

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

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

Enums

eCheckinSource — Source values

Value	Name
1	Manual
2	DoorAccess
3	NetworkActivity
4	Tile
5	Sensor

Request Body

Required Fields

integer

required

The Id of the Checkin record to update.

integer

required

ID of the location where the customer checked in. The Admin Agent supplies the current location for create and update operations..

string

required

Check-in start date and time, stored in UTC and rounded to the nearest 15 minutes. It must be earlier than ToTime when a checkout time is provided..

Optional Fields

integer

ID of the customer checking in. The customer must be active; the system first uses an eligible customer or shared pass, then can fall back to an eligible pay-as-you-go pass when the location allows it..

string

Optional checkout date and time, stored in UTC and rounded to the nearest 15 minutes. Leave empty to keep the check-in open; when set, it must be later than FromTime..

boolean

System-calculated flag copied from the pass used for this check-in; it determines whether the duration counts against the customer’s plan limits..

string

Internal GUID of the customer pass selected or created by check-in validation; choose an eligible pass through the check-in workflow instead..

boolean

Internal flag set by automated check-in sources to request later checkout validation; it is not a manual check-in setting..

string

Internal UTC timestamp of the most recent activity reported by a network or access-control integration for this open check-in..

string

Internal comma-separated device MAC addresses captured by a network-activity check-in; this network identifier is managed by integrations..

string

System-generated comma-separated snapshot of the customer’s team names when the check-in was created..

string

System-generated comma-separated snapshot of the customer’s active plan names when the check-in was created..

string

Internal scheduler job ID used to prevent duplicate automatic checkout validation for an open check-in..

string

Internal location-local representation of FromTime generated for reporting; set FromTime instead..

string

Internal location-local representation of ToTime generated for reporting; set ToTime instead..

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/spaces/checkins" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "FromTime": "2025-01-15T10:30:00Z",
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/checkins',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      FromTime: '2025-01-15T10:30:00Z',
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/spaces/checkins',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'FromTime': '2025-01-15T10:30:00Z',
        '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 checkin was updated successfully.

array

null on success.

Example Response

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

Update Checkin

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

import requests

url = "https://spaces.nexudus.com/api/spaces/checkins"

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

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