Clear Occupant Presence Status

post

https://{subdomain}.maptician.com/ext/v1/presence/checkout

Clears an Occupant's current presence status (i.e., checks the Occupant out). This sets the user's presence state to clear. You must identify the Occupant using one of the supported identifiers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Identify the Occupant to clear (check out). Provide exactly one identifier if possible (unless using first/last). The server will attempt lookup in the following order of precedence - userID, email, employeeID, externalId, then name/first+last. At least one identifier is required.

userID

uuid

The Maptician user identifier for the Occupant.

string

The Occupant's email address (case-insensitive).

employeeID

string

Organization-specific employee identifier (case-sensitive).

externalId

string

An external system identifier mapped to the Occupant.

name

string

Concatenated first and last name (least preferred due to ambiguity).

first

string

First/given name; must be used with 'last' when 'name' is not provided.

last

string

Last/family name; must be used with 'first' when 'name' is not provided.

Headers

mapticianauth

string

required

Authorization token to access the API.

Responses

500

Server Error

200Presence cleared successfully

400Invalid Request