Update User Publisher Read Only Data

Updates the publisher-specific custom data for the user which can only be read by the client

Error codes

This operation may return the following PlayFab errors:

Error	Code
PublisherNotSet	1122

POST

Admin

UpdateUserPublisherReadOnlyData

Update User Publisher Read Only Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "2039475",
  "Data": {
    "Class": "Fighter",
    "Gender": "Female",
    "Icon": "Guard 3",
    "Theme": "Colorful"
  },
  "Permission": "Public"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData"

payload = {
    "PlayFabId": "2039475",
    "Data": {
        "Class": "Fighter",
        "Gender": "Female",
        "Icon": "Guard 3",
        "Theme": "Colorful"
    },
    "Permission": "Public"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '2039475',
    Data: {Class: 'Fighter', Gender: 'Female', Icon: 'Guard 3', Theme: 'Colorful'},
    Permission: 'Public'
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '2039475',
    'Data' => [
        'Class' => 'Fighter',
        'Gender' => 'Female',
        'Icon' => 'Guard 3',
        'Theme' => 'Colorful'
    ],
    'Permission' => 'Public'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "DataVersion": 8
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-SecretKey

string

header

required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

This function performs an additive update of the arbitrary JSON object containing the custom data for the user. In updating the custom data object, keys which already exist in the object will have their values overwritten, while keys with null values will be removed. No other key-value pairs will be changed apart from those specified in the call.

PlayFabId

string

required

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Data

object

Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may not begin with a '!' character or be null.

KeysToRemove

string[]

Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language constraints. Use this to delete the keys directly.

Permission

enum<string>

Permission to be applied to all user data keys written in this request. Defaults to "private" if not set.

Available options:

Private,

Public

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Example:

{ "DataVersion": 8 }

Last modified on October 1, 2026

⌘I

Update User Publisher Read Only Data

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "2039475",
  "Data": {
    "Class": "Fighter",
    "Gender": "Female",
    "Icon": "Guard 3",
    "Theme": "Colorful"
  },
  "Permission": "Public"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData"

payload = {
    "PlayFabId": "2039475",
    "Data": {
        "Class": "Fighter",
        "Gender": "Female",
        "Icon": "Guard 3",
        "Theme": "Colorful"
    },
    "Permission": "Public"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '2039475',
    Data: {Class: 'Fighter', Gender: 'Female', Icon: 'Guard 3', Theme: 'Colorful'},
    Permission: 'Public'
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '2039475',
    'Data' => [
        'Class' => 'Fighter',
        'Gender' => 'Female',
        'Icon' => 'Guard 3',
        'Theme' => 'Colorful'
    ],
    'Permission' => 'Public'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"2039475\",\n  \"Data\": {\n    \"Class\": \"Fighter\",\n    \"Gender\": \"Female\",\n    \"Icon\": \"Guard 3\",\n    \"Theme\": \"Colorful\"\n  },\n  \"Permission\": \"Public\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "DataVersion": 8
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Update User Publisher Read Only Data

Error codes

Authorizations

Body

Response