---
updatedAt: 2025-11-11T02:12:03.000Z
agentTools:
  projectIndex: https://beamable2.readme.io/llms.txt
---

# post

# OpenAPI definition

```json
{
  "info": {
    "title": "event-players object",
    "version": "1.0",
    "contact": {
      "name": "Beamable Support",
      "url": "https://api.beamable.com",
      "email": "support@beamable.com"
    }
  },
  "servers": [
    {
      "url": "https://api.beamable.com"
    }
  ],
  "paths": {
    "/object/event-players/{objectId}/claim": {
      "post": {
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventClaimResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "parameters": [
          {
            "name": "objectId",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EventClaimRequest"
              }
            }
          }
        },
        "security": [
          {
            "scope": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "EventInventoryRewardItem": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "properties": {
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "ItemCreateRequest": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "contentId": {
            "type": "string"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemProperty"
            }
          }
        }
      },
      "EventClaimResponse": {
        "properties": {
          "view": {
            "$ref": "#/components/schemas/EventPlayerStateView"
          },
          "gameRspJson": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "title": "Event Claim Response",
        "type": "object"
      },
      "EventPlayerReward": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "pendingInventoryRewards": {
            "$ref": "#/components/schemas/EventInventoryPendingRewards"
          },
          "currencies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventInventoryRewardCurrency"
            }
          },
          "pendingCurrencyRewards": {
            "type": "object",
            "additionalProperties": true
          },
          "pendingItemRewards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemCreateRequest"
            }
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventInventoryRewardItem"
            }
          },
          "min": {
            "type": "number"
          },
          "max": {
            "type": "number"
          },
          "earned": {
            "type": "boolean"
          },
          "claimed": {
            "type": "boolean"
          },
          "pendingEntitlementRewards": {
            "type": "object",
            "additionalProperties": true
          },
          "obtain": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventRewardObtain"
            }
          }
        },
        "required": [
          "min",
          "earned",
          "claimed"
        ]
      },
      "EventRewardObtain": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "symbol": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "count"
        ]
      },
      "EventClaimRequest": {
        "properties": {
          "eventId": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "title": "Event Claim Request",
        "type": "object"
      },
      "EventInventoryRewardCurrency": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "amount"
        ]
      },
      "EventInventoryPendingRewards": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "currencies": {
            "type": "object",
            "additionalProperties": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemCreateRequest"
            }
          },
          "empty": {
            "type": "boolean"
          }
        },
        "required": [
          "empty"
        ]
      },
      "EventPlayerStateView": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "running": {
            "type": "boolean"
          },
          "allPhases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventPlayerPhaseView"
            }
          },
          "rank": {
            "type": "integer"
          },
          "score": {
            "type": "number"
          },
          "currentPhase": {
            "$ref": "#/components/schemas/EventPlayerPhaseView"
          },
          "secondsRemaining": {
            "type": "integer"
          },
          "id": {
            "type": "string"
          },
          "leaderboardId": {
            "type": "string"
          },
          "rankRewards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventPlayerReward"
            }
          },
          "scoreRewards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventPlayerReward"
            }
          }
        },
        "required": [
          "score",
          "rank",
          "running",
          "secondsRemaining"
        ]
      },
      "EventPlayerPhaseView": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "durationSeconds": {
            "type": "integer"
          },
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventRule"
            }
          }
        },
        "required": [
          "durationSeconds"
        ]
      },
      "ItemProperty": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "EventRule": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "rule": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "scope": {
        "type": "apiKey",
        "name": "X-DE-SCOPE",
        "in": "header",
        "description": "Customer and project scope. This should contain the '<customer-id>.<project-id>'."
      }
    }
  },
  "security": [],
  "externalDocs": {
    "description": "Beamable Documentation",
    "url": "https://docs.beamable.com"
  },
  "openapi": "3.0.2",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```