Execute Function

Cloud Script is one of PlayFab’s most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.

Error codes

This operation may return the following PlayFab errors:

Error	Code
CloudScriptAzureFunctionsArgumentSizeExceeded	1471
CloudScriptAzureFunctionsEventHubRequestError	1579
CloudScriptAzureFunctionsExecutionTimeLimitExceeded	1470
CloudScriptAzureFunctionsHTTPRequestError	1473
CloudScriptAzureFunctionsQueueRequestError	1494
CloudScriptAzureFunctionsReturnSizeExceeded	1472
InvalidEntityType	1373

POST

CloudScript

ExecuteFunction

Execute Function

curl --request POST \
  --url https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "FunctionName": "LevelCompleted",
  "FunctionParameter": {
    "level": 3,
    "points": 400
  },
  "GeneratePlayStreamEvent": true,
  "Entity": {
    "Id": "aaa",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction"

payload = {
    "FunctionName": "LevelCompleted",
    "FunctionParameter": {
        "level": 3,
        "points": 400
    },
    "GeneratePlayStreamEvent": True,
    "Entity": {
        "Id": "aaa",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
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({
    FunctionName: 'LevelCompleted',
    FunctionParameter: {level: 3, points: 400},
    GeneratePlayStreamEvent: true,
    Entity: {Id: 'aaa', Type: 'title_player_account', TypeString: 'title_player_account'}
  })
};

fetch('https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction', 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/CloudScript/ExecuteFunction",
  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([
    'FunctionName' => 'LevelCompleted',
    'FunctionParameter' => [
        'level' => 3,
        'points' => 400
    ],
    'GeneratePlayStreamEvent' => true,
    'Entity' => [
        'Id' => 'aaa',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  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/CloudScript/ExecuteFunction"

	payload := strings.NewReader("{\n  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\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/CloudScript/ExecuteFunction")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction")

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  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "ExecutionTimeMilliseconds": 367,
    "FunctionName": "LevelCompleted",
    "FunctionResult": {
      "newScore": 25
    },
    "FunctionResultSize": 43
  }
}

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

Authorizations

X-EntityToken

string

header

required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Executes an Azure Function with the profile of the entity that is defined in the request.

FunctionName

string

required

The name of the CloudScript function to execute

CustomTags

object

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

Entity

object

The optional entity to perform this action on. Defaults to the currently logged in entity.

Show child attributes

FunctionParameter

object

Object that is passed in to the function as the FunctionArgument field of the FunctionExecutionContext data structure

GeneratePlayStreamEvent

boolean

Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.

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:

{
  "ExecutionTimeMilliseconds": 367,
  "FunctionName": "LevelCompleted",
  "FunctionResult": { "newScore": 25 },
  "FunctionResultSize": 43
}

Last modified on October 1, 2026

⌘I

Execute Function

curl --request POST \
  --url https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "FunctionName": "LevelCompleted",
  "FunctionParameter": {
    "level": 3,
    "points": 400
  },
  "GeneratePlayStreamEvent": true,
  "Entity": {
    "Id": "aaa",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction"

payload = {
    "FunctionName": "LevelCompleted",
    "FunctionParameter": {
        "level": 3,
        "points": 400
    },
    "GeneratePlayStreamEvent": True,
    "Entity": {
        "Id": "aaa",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
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({
    FunctionName: 'LevelCompleted',
    FunctionParameter: {level: 3, points: 400},
    GeneratePlayStreamEvent: true,
    Entity: {Id: 'aaa', Type: 'title_player_account', TypeString: 'title_player_account'}
  })
};

fetch('https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction', 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/CloudScript/ExecuteFunction",
  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([
    'FunctionName' => 'LevelCompleted',
    'FunctionParameter' => [
        'level' => 3,
        'points' => 400
    ],
    'GeneratePlayStreamEvent' => true,
    'Entity' => [
        'Id' => 'aaa',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  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/CloudScript/ExecuteFunction"

	payload := strings.NewReader("{\n  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\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/CloudScript/ExecuteFunction")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/CloudScript/ExecuteFunction")

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  \"FunctionName\": \"LevelCompleted\",\n  \"FunctionParameter\": {\n    \"level\": 3,\n    \"points\": 400\n  },\n  \"GeneratePlayStreamEvent\": true,\n  \"Entity\": {\n    \"Id\": \"aaa\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "ExecutionTimeMilliseconds": 367,
    "FunctionName": "LevelCompleted",
    "FunctionResult": {
      "newScore": 25
    },
    "FunctionResultSize": 43
  }
}

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

PlayFab API

PlayFab REST API References

Execute Function

Error codes

Authorizations

Body

Response