POST (/users/xuid({xuid})/devices/current/titles/current)
Update a title with a user's presence.
The domain for these URIs is userpresence.xboxlive.com.
- Remarks
- URI parameters
- Authorization
- Required Request Headers
- Optional Request Headers
- Request body
- Response body
Remarks
This URI can be used by all titles on non-console platforms to add and update the presence, rich presence, and media presence data for a title.
SandboxId is now retrieved from the claim in the XToken and enforced. If the SandboxId is not present, then Entertainment Discovery Services (EDS) will throw a 400 Bad request error.
URI parameters
| Parameter | Type | Description |
|---|---|---|
| xuid | 64-bit unsigned integer | Xbox User ID (XUID) of the target user. |
Authorization
| Type | Required | Description | Response if missing |
|---|---|---|---|
| XUID | Yes | Xbox User ID (XUID) of the caller | 403 Forbidden |
| titleId | Yes | titleId of the title | 403 Forbidden |
| deviceId | Yes for all except Windows and Web | deviceId of the caller | 403 Forbidden |
| deviceType | Yes for all except Web | deviceType of the caller | 403 Forbidden |
| sandboxId | Yes for calls coming from | sandbox of the caller | 403 Forbidden |
Required Request Headers
| Header | Type | Description |
|---|---|---|
| Authorization | string | Authentication credentials for HTTP authentication. Example value: "XBL3.0 x=<userhash>;<token>". |
| x-xbl-contract-version | string | Build name/number of the Xbox LIVE service to which this request should be directed. The request will only be routed to that service after verifying the validity of the header, the claims in the auth token, and so on. Example values: 3, vnext. |
| Content-Type | string | The mime type of the body of the request Example value: application/json. |
| Content-Length | string | The length of the request body. Example value: 312. |
| Host | string | Domain name of the server. Example value: presencebeta.xboxlive.com. |
Optional Request Headers
| Header | Type | Description |
|---|---|---|
| X-RequestedServiceVersion | Build name/number of the Xbox LIVE service to which this request should be directed. The request will only be routed to that service after verifying the validity of the header, the claims in the auth token, and so on. Default value: 1. |
Request body
The request object is a TitleRequest. Only the properties actually present in the body are updated. Any properties that are not part of the body but exist on the server will not be modified.
Sample request
{
id:"12341234",
placement:"snapped",
state:"active"
}
Response body
In case of success, an HTTP status code of 200 or 201 Created is returned, as appropriate.
In case of an error (HTTP 4xx or 5xx), appropriate error information is returned in the response body.
See also
Parent
/users/xuid({xuid})/devices/current/titles/current