Create Draft Item
Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.
Allowed entity token types: title, master_player_account, title_player_account
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| CatalogBadRequest | 4013 |
| DatabaseThroughputExceeded | 1113 |
| InvalidRequest | 1071 |
| ItemNotFound | 1047 |
| NotImplemented | 1515 |
POST
/
Catalog
/
CreateDraftItem
Create Draft Item
curl --request POST \
--url https://{titleId}.playfabapi.com/Catalog/CreateDraftItem \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Item": {
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"DefaultStackId": "Static_Default_Stack_Id"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Catalog/CreateDraftItem"
payload = { "Item": {
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": { "NEUTRAL": { "Values": ["Keyword_1", "Keyword_2"] } },
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": False,
"Tags": ["pirates", "holiday"],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"DefaultStackId": "Static_Default_Stack_Id"
} }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Item: {
Type: 'ugc',
Title: {NEUTRAL: 'Neutral title', 'en-US': 'US English title'},
Description: {NEUTRAL: 'Neutral description', 'en-US': 'US English description'},
Keywords: {NEUTRAL: {Values: ['Keyword_1', 'Keyword_2']}},
ContentType: 'example item',
CreatorEntity: {Id: 'someId', Type: 'title_player_account', TypeString: 'title_player_account'},
IsHidden: false,
Tags: ['pirates', 'holiday'],
DisplayVersion: '1.0.0',
CreationDate: '2018-08-17T22:32:10.4729879+00:00',
Contents: [
{
Id: '00000000-0000-0000-0000-000000000001',
Url: 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip',
MaxClientVersion: '2.4.1',
MinClientVersion: '2.0.0'
}
],
Images: [
{
Id: '00000000-0000-0000-0000-000000000003',
Type: 'Thumbnail',
Url: 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg'
}
],
DisplayProperties: {
mapDetails: {mapType: 'desertIsland', gameMode: 'capture', maxPlayers: 16},
averageMatchLengthInSeconds: 947
},
DefaultStackId: 'Static_Default_Stack_Id'
}
})
};
fetch('https://{titleId}.playfabapi.com/Catalog/CreateDraftItem', 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/Catalog/CreateDraftItem",
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([
'Item' => [
'Type' => 'ugc',
'Title' => [
'NEUTRAL' => 'Neutral title',
'en-US' => 'US English title'
],
'Description' => [
'NEUTRAL' => 'Neutral description',
'en-US' => 'US English description'
],
'Keywords' => [
'NEUTRAL' => [
'Values' => [
'Keyword_1',
'Keyword_2'
]
]
],
'ContentType' => 'example item',
'CreatorEntity' => [
'Id' => 'someId',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
],
'IsHidden' => false,
'Tags' => [
'pirates',
'holiday'
],
'DisplayVersion' => '1.0.0',
'CreationDate' => '2018-08-17T22:32:10.4729879+00:00',
'Contents' => [
[
'Id' => '00000000-0000-0000-0000-000000000001',
'Url' => 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip',
'MaxClientVersion' => '2.4.1',
'MinClientVersion' => '2.0.0'
]
],
'Images' => [
[
'Id' => '00000000-0000-0000-0000-000000000003',
'Type' => 'Thumbnail',
'Url' => 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg'
]
],
'DisplayProperties' => [
'mapDetails' => [
'mapType' => 'desertIsland',
'gameMode' => 'capture',
'maxPlayers' => 16
],
'averageMatchLengthInSeconds' => 947
],
'DefaultStackId' => 'Static_Default_Stack_Id'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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/Catalog/CreateDraftItem"
payload := strings.NewReader("{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<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/Catalog/CreateDraftItem")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Catalog/CreateDraftItem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Item": {
"Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
application/json
The item will not be published to the public catalog until the PublishItem API is called for the item.
The item will not be published to the public catalog until the PublishItem API is called for the item.
Whether the item should be published immediately. This value is optional, defaults to false.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Metadata describing the new catalog item to be created.
Show child attributes
Show child attributes
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
Example:
{ "Item": { "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd", "Type": "ugc", "Title": { "NEUTRAL": "Neutral title", "en-US": "US English title" }, "Description": { "NEUTRAL": "Neutral description", "en-US": "US English description" }, "Keywords": { "NEUTRAL": { "Values": ["Keyword_1", "Keyword_2"] } }, "ContentType": "example item", "CreatorEntity": { "Id": "someId", "Type": "title_player_account", "TypeString": "title_player_account" }, "IsHidden": false, "Tags": ["pirates", "holiday"], "DisplayVersion": "1.0.0", "CreationDate": "2018-08-17T22:32:10.4729879+00:00", "LastModifiedDate": "2018-08-17T22:32:31.911375+00:00", "Contents": [ { "Id": "00000000-0000-0000-0000-000000000001", "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip", "MaxClientVersion": "2.4.1", "MinClientVersion": "2.0.0" } ], "Images": [ { "Id": "00000000-0000-0000-0000-000000000003", "Type": "Thumbnail", "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg" } ], "DisplayProperties": { "mapDetails": { "mapType": "desertIsland", "gameMode": "capture", "maxPlayers": 16 }, "averageMatchLengthInSeconds": 947 }, "ETag": "opaqueString", "DefaultStackId": "Static_Default_Stack_Id" } }
Last modified on October 1, 2026
Was this page helpful?
⌘I
Create Draft Item
curl --request POST \
--url https://{titleId}.playfabapi.com/Catalog/CreateDraftItem \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Item": {
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"DefaultStackId": "Static_Default_Stack_Id"
}
}
'import requests
url = "https://{titleId}.playfabapi.com/Catalog/CreateDraftItem"
payload = { "Item": {
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": { "NEUTRAL": { "Values": ["Keyword_1", "Keyword_2"] } },
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": False,
"Tags": ["pirates", "holiday"],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"DefaultStackId": "Static_Default_Stack_Id"
} }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Item: {
Type: 'ugc',
Title: {NEUTRAL: 'Neutral title', 'en-US': 'US English title'},
Description: {NEUTRAL: 'Neutral description', 'en-US': 'US English description'},
Keywords: {NEUTRAL: {Values: ['Keyword_1', 'Keyword_2']}},
ContentType: 'example item',
CreatorEntity: {Id: 'someId', Type: 'title_player_account', TypeString: 'title_player_account'},
IsHidden: false,
Tags: ['pirates', 'holiday'],
DisplayVersion: '1.0.0',
CreationDate: '2018-08-17T22:32:10.4729879+00:00',
Contents: [
{
Id: '00000000-0000-0000-0000-000000000001',
Url: 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip',
MaxClientVersion: '2.4.1',
MinClientVersion: '2.0.0'
}
],
Images: [
{
Id: '00000000-0000-0000-0000-000000000003',
Type: 'Thumbnail',
Url: 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg'
}
],
DisplayProperties: {
mapDetails: {mapType: 'desertIsland', gameMode: 'capture', maxPlayers: 16},
averageMatchLengthInSeconds: 947
},
DefaultStackId: 'Static_Default_Stack_Id'
}
})
};
fetch('https://{titleId}.playfabapi.com/Catalog/CreateDraftItem', 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/Catalog/CreateDraftItem",
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([
'Item' => [
'Type' => 'ugc',
'Title' => [
'NEUTRAL' => 'Neutral title',
'en-US' => 'US English title'
],
'Description' => [
'NEUTRAL' => 'Neutral description',
'en-US' => 'US English description'
],
'Keywords' => [
'NEUTRAL' => [
'Values' => [
'Keyword_1',
'Keyword_2'
]
]
],
'ContentType' => 'example item',
'CreatorEntity' => [
'Id' => 'someId',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
],
'IsHidden' => false,
'Tags' => [
'pirates',
'holiday'
],
'DisplayVersion' => '1.0.0',
'CreationDate' => '2018-08-17T22:32:10.4729879+00:00',
'Contents' => [
[
'Id' => '00000000-0000-0000-0000-000000000001',
'Url' => 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip',
'MaxClientVersion' => '2.4.1',
'MinClientVersion' => '2.0.0'
]
],
'Images' => [
[
'Id' => '00000000-0000-0000-0000-000000000003',
'Type' => 'Thumbnail',
'Url' => 'https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg'
]
],
'DisplayProperties' => [
'mapDetails' => [
'mapType' => 'desertIsland',
'gameMode' => 'capture',
'maxPlayers' => 16
],
'averageMatchLengthInSeconds' => 947
],
'DefaultStackId' => 'Static_Default_Stack_Id'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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/Catalog/CreateDraftItem"
payload := strings.NewReader("{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<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/Catalog/CreateDraftItem")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Catalog/CreateDraftItem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.4729879+00:00\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Item": {
"Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"Type": "ugc",
"Title": {
"NEUTRAL": "Neutral title",
"en-US": "US English title"
},
"Description": {
"NEUTRAL": "Neutral description",
"en-US": "US English description"
},
"Keywords": {
"NEUTRAL": {
"Values": [
"Keyword_1",
"Keyword_2"
]
}
},
"ContentType": "example item",
"CreatorEntity": {
"Id": "someId",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"IsHidden": false,
"Tags": [
"pirates",
"holiday"
],
"DisplayVersion": "1.0.0",
"CreationDate": "2018-08-17T22:32:10.4729879+00:00",
"LastModifiedDate": "2018-08-17T22:32:31.911375+00:00",
"Contents": [
{
"Id": "00000000-0000-0000-0000-000000000001",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
"MaxClientVersion": "2.4.1",
"MinClientVersion": "2.0.0"
}
],
"Images": [
{
"Id": "00000000-0000-0000-0000-000000000003",
"Type": "Thumbnail",
"Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
}
],
"DisplayProperties": {
"mapDetails": {
"mapType": "desertIsland",
"gameMode": "capture",
"maxPlayers": 16
},
"averageMatchLengthInSeconds": 947
},
"ETag": "opaqueString",
"DefaultStackId": "Static_Default_Stack_Id"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}