POST /give/paleggs/{player_identifier}
Endpoint: POST /v1/pdapi/give/paleggs/<player_identifier>
Auth: Bearer token
Permission: REST.PalEggs.Give
Purpose
Gives one or more Pal eggs to the target player.
Path parameters
player_identifier:UserIdorPlayerUIDfor the target player.
Query parameters
None.
Request body
JSON object with PalEggs, an array of egg grants. EggID is an ItemID. Each egg must use either PalID or PalTemplate, not both.
Response schema
200 response schema
| Field | Type | Description |
|---|---|---|
Granted |
object | Counts granted by the request. |
Granted object schema:
| Field | Type | Description |
|---|---|---|
PalEggs |
integer | Number of Pal eggs 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 PalEggs array. |
400 |
VALIDATION_FAILED |
One or more egg grants are invalid, cannot be imported, or do not fit in inventory. |
Examples
Give a leveled egg to a Steam player
Give template-backed egg by PlayerUID
Scenarios
- Give event eggs without spawning the Pal immediately.
- Use
PalIDfor simple eggs andPalTemplatefor custom egg contents. - The request can fail if the egg
ItemIDis invalid or the player inventory has no space.