POST (/users/batch/profile/settings)

Get the profile for a user or users. The domain for these URIs is profile.xboxlive.com.

Remarks

This is the only fully-qualified Profile URL allowed in . All other Profile APIs from clients are blocked.

Authorization

To access a profile, only a normal auth token and claims are needed.

Required Request Headers

Header Type Description
x-xbl-contract-version 32-bit unsigned integer The contract version must be set to 2, to distinguish this call from the Xbox 360 API.
content-type string Value = application/json

Request body

Sample request

POST /users/batch/profile/settings
   {
      "userIds":[
         "2533274791381930"
       ],
      "settings":[
         "GameDisplayName",
         "GameDisplayPicRaw",
         "Gamerscore",
         "Gamertag"
      ]
   }
      

Response body

Sample response

{
      "profileUsers":[
         {
            "id":"2533274791381930",
            "settings":[
               {
                  "id":"GameDisplayName",
                  "value":"John Smith"
               },
               {
                  "id":"GameDisplayPicRaw",
                  "value":"http://images-eds.xboxlive.com/image?url=z951ykn43p4FqWbbFvR2Ec.8vbDhj8G2Xe7JngaTToBrrCmIEEXHC9UNrdJ6P7KIN0gxC2r1YECCd3mf2w1FDdmFCpSokJWa2z7xtVrlzOyVSc6pPRdWEXmYtpS2xE4F"
               },
               {
                  "id":"Gamerscore",
                  "value":"0"
               },
               {
                  "id":"Gamertag",
                  "value":"CracklierJewel9"
               }
            ]
         }
      ]
   }
         

See also

Parent

/users/batch/profile/settings

Reference

Profile (JSON)