{"_id":"5866bc138381732d00cc08db","project":"5435693035740020002a1c1c","user":"543568c135740020002a1c10","version":{"_id":"5435693035740020002a1c1f","__v":15,"project":"5435693035740020002a1c1c","createdAt":"2014-10-08T16:41:20.702Z","releaseDate":"2014-10-08T16:41:20.702Z","categories":["5435693035740020002a1c20","551c03c1ff892b3700d1c57a","551ca3927405910d00900a59","551cac6448564a2f0024d89e","551cb4d848564a2f0024d8a3","551cb52db7a32b3b00d1ef78","5526e2064a7ac121004c6073","5526e5147d4a4417009516b3","5526e9877d4a4417009516bb","5528362cd9e1db2d00cd924d","5580240ebe698419008f2ba2","5580a7dabe698419008f2db6","568161799de23c0d00c54750","5866c905a2cbb31900f6f1aa","5bfc066d8342500013783e0c"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5526e2064a7ac121004c6073","project":"5435693035740020002a1c1c","pages":["5526e2674a7ac121004c6075","5526e439e69c7d0d00047e57"],"__v":2,"version":"5435693035740020002a1c1f","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-09T20:33:10.475Z","from_sync":false,"order":6,"slug":"locations","title":"Locations"},"githubsync":"","parentDoc":null,"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-30T19:57:07.266Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"delete","results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"status_code\": 200,\n    \"status\": \"OK\",\n    \"message\": \"\",\n    \"more_info\": {}\n  },\n  \"data\": {}\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"DELETE /v1.0/locations/10/presence HTTP/1.1\nHost: api.robinpowered.com\nContent-Type: application/json\nAuthorization: Access-Token :accessToken\n\n{\n\t\"user_id\": 42\n}","language":"http"}]},"auth":"required","params":[{"_id":"551c0ce223a1ee190034d100","ref":"","in":"path","required":true,"desc":"The ID of the location to remove presence from.","default":"","type":"int","name":"id"},{"_id":"551ca58035f9812f008ccd34","ref":"","in":"body","required":true,"desc":"The ID of the user who is present.","default":"","type":"int","name":"user_id"},{"_id":"551ca58035f9812f008ccd33","ref":"","in":"body","required":true,"desc":"The ID of the device reporting the presence. This parameter is only required if `user_ref` is omitted.","default":"","type":"string","name":"device_id"}],"url":"/spaces/:id/presence"},"isReference":true,"order":6,"body":"Instead of waiting for a presence's TTL to run its course, the presence \"session\" can be manually ended by using this endpoint. This will override the existing expired_at attribute by setting it to be the current time.","excerpt":"Expire a user or device's presence in a space","slug":"delete-location-presence","type":"endpoint","title":"/locations/:id/presence"}

delete/locations/:id/presence

Expire a user or device's presence in a space

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
The ID of the location to remove presence from.

Body Params

user_id:
required
integer
The ID of the user who is present.
device_id:
required
string
The ID of the device reporting the presence. This parameter is only required if `user_ref` is omitted.

Examples


Result Format


Documentation

Instead of waiting for a presence's TTL to run its course, the presence "session" can be manually ended by using this endpoint. This will override the existing expired_at attribute by setting it to be the current time.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}