POST (/users//people/xuids)

Gets people by XUID from caller’s people collection. The domain for these URIs is social.xboxlive.com.

Remarks
URI parameters
Authorization
Required Request Headers
Optional Request Headers
Request body
HTTP status codes
Required Response Headers
Response body

Remarks

POST operations won’t modify any resources so this will produce the same results if executed once or multiple times.

URI parameters

Parameter	Type	Description
ownerId	string	Identifier of the user whose resource is being accessed. Must match the authenticated user. The possible values are “me”, xuid(), or gt().

Authorization

| Type| Required| Description| Response if missing| | --- | --- | --- | --- | --- | --- | --- | | XUID| yes| Caller has user’s XBOX User ID (XUID).| 401 Unauthorized|

Required Request Headers

| Header| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| String. Authorization data for XBOX LIVE. This is typically an encrypted XSTS token. Example value: XBL3.0 x=<userhash>;<token>.| | Content-Length| 32-bit unsigned integer. Length, in bytes, of the request body. Example value: 22.| | Content-Type| String. MIME type of the request body. This must be application/json.|

Optional Request Headers

| Header| 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, etc. Default value: 1.| | Accept| String. Content-Types that the caller accepts in the response. All responses are application/json.|

Request body

Required members

| Member| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | XuidList| Array of XUIDs that identify the people to be returned from the caller’s people collection. See XuidList (JSON).|

Optional members

There are no optional members for this request.

Prohibited members

All other members are prohibited in a request.

Sample request

{
    "xuids": [
        "2533274790395904", 
        "2533274792986770", 
        "2533274794866999"
    ]
}
      

HTTP status codes

The service returns one of the status codes in this section in response to a request made with this method on this resource. For a complete list of standard HTTP status codes used with XBOX Live Services, see Standard HTTP status codes. | Code| Reason phrase| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| Success when method is “get”.| | 204| No Content| Success when method is “add” or “remove”.| | 400| Bad Request| Method parameter was missing or malformed, or user IDs were malformed.| | 403| Forbidden| XUID claim could not be parsed from the authorization header.|

Required Response Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Content-Length| 32-bit unsigned integer| Length, in bytes, of the response body. Example value: 22.| | Content-Type| string| MIME type of the response body. This will always be application/json.|

Response body

A response body is only sent when the request method is “get”. There is no response body for “add” or “remove”. If a “get” method call is successful, the service returns the total number of people in the caller’s people collection, and an array containing the caller’s people collection. No response is returned for “add” and “remove” methods. See PeopleList (JSON).

Sample response

{
    "people": [
        {
            "xuid": "2603643534573573",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573572",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573577",
            "isFavorite": false,
            "isFollowingCaller": false
        },
    ],
    "totalCount": 3
}
         

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

POST (/users/{ownerId}/people/xuids)

POST (/users//people/xuids)

Remarks

URI parameters

Authorization

Required Request Headers

Optional Request Headers

Request body

Required members

Optional members

Prohibited members

Sample request

HTTP status codes

Required Response Headers

Response body

Sample response

See also

Parent

​POST (/users//people/xuids)

​Remarks

​URI parameters

​Authorization

​Required Request Headers

​Optional Request Headers

​Request body

​Required members

​Optional members

​Prohibited members

​Sample request

​HTTP status codes

​Required Response Headers

​Response body

​Sample response

​See also

Parent

POST (/users//people/xuids)

Remarks

URI parameters

Authorization

Required Request Headers

Optional Request Headers

Request body

Required members

Optional members

Prohibited members

Sample request

HTTP status codes

Required Response Headers

Response body

Sample response

See also