POST /give/pals/{player_identifier}
Endpoint: POST /v1/pdapi/give/pals/<player_identifier>
Auth: Bearer token
Permission: REST.Pals.Give
Purpose
Gives one or more Pals by ID and level.
Path parameters
player_identifier:UserIdorPlayerUIDfor the target player.
Query parameters
None.
Request body
JSON object with Pals, an array of Pal grants. Each entry needs a PalID and positive Level.
Response schema
200 response schema
| Field | Type | Description |
|---|---|---|
Granted |
object | Counts granted by the request. |
Granted object schema:
| Field | Type | Description |
|---|---|---|
Pals |
integer | Number of Pals granted. |
Error responses
Error bodies use this shape:
| HTTP | Error code | When it happens |
|---|---|---|
401 |
INVALID_TOKEN |
The Authorization header is missing, malformed, or does not match a configured bearer token. |
403 |
MISSING_PERMISSION |
The token is valid, but it does not include this endpoint permission. |
400 |
INVALID_JSON |
A request body was supplied, but it could not be parsed as JSON. |
400 |
REQUEST_FAILED |
The game-thread callback threw an exception, or a shared player/resource resolver failed. |
500 |
REQUEST_TIMEOUT |
The internal game-thread callback did not complete within 5 seconds. |
400 |
INVALID_REQUEST |
The body does not contain a Pals array. |
400 |
VALIDATION_FAILED |
One or more Pal grants are invalid, or the player has insufficient Pal storage space. |
Examples
Give a starter Pal to a GDK player
Give event Pals by PlayerUID
Scenarios
- Give simple Pal rewards without maintaining a template file.
- Use for random reward scripts that only vary
PalIDandLevel. - The request can fail if the player cannot be found, the
PalIDis invalid, or there is not enough Pal storage space.