{"_id":"551cac0d35f9812f008ccd38","__v":1,"editedParams2":true,"project":"5435693035740020002a1c1c","version":{"_id":"5435693035740020002a1c1f","__v":14,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"editedParams":true,"parentDoc":null,"user":"543569cd35740020002a1c2d","category":{"_id":"551c03c1ff892b3700d1c57a","pages":["551c056aefc11923006421e8","551c0b2befc11923006421f3","551c0ce223a1ee190034d0ff","551ca30f7405910d00900a57","551ca412b7a32b3b00d1ef69","551ca4e335f9812f008ccd31","551cac0d35f9812f008ccd38","551cae3bd65a6d19007a8e6a","551caef7b7a32b3b00d1ef70","551cb06448564a2f0024d8a0","551cb24435f9812f008ccd3c","551cb2a8d65a6d19007a8e75","551cb4cfb7a32b3b00d1ef76","552926c5ceedaa0d00bc5c71"],"version":"5435693035740020002a1c1f","__v":14,"project":"5435693035740020002a1c1c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-01T14:42:09.907Z","from_sync":false,"order":7,"slug":"spaces","title":"Spaces"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-02T02:40:13.017Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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":[{"language":"http","code":"DELETE /v1.0/spaces/50/presence HTTP/1.1\nHost: api.robinpowered.com\nContent-Type: application/json\nAuthorization: Access-Token :accessToken\n\n{\n\t\"user_id\": 42\n}"}]},"method":"delete","auth":"required","params":[{"_id":"551c0ce223a1ee190034d100","ref":"","in":"path","required":true,"desc":"The ID of the space to remove presence from.","default":"","type":"int","name":"id"},{"_id":"551ca58035f9812f008ccd34","ref":"","in":"body","required":true,"desc":"The ID or slug of the user who is present.","default":"","type":"string","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":11,"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-space-presence","type":"endpoint","title":"/spaces/:id/presence"}

delete/spaces/: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 space to remove presence from.

Body Params

user_id:
required
string
The ID or slug 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 }}