> ## Documentation Index
> Fetch the complete documentation index at: https://docs.series.hr/llms.txt
> Use this file to discover all available pages before exploring further.

# Claim Custom Role

> Claim a vacant custom role slot in a session

Claim a vacant custom role slot in a session. The user must meet the minimum rank requirement for the role, and the session must be claimable.

<Note>Custom roles are a **Premium/Enterprise** feature. This endpoint will return a 403 error for free-tier workspaces.</Note>

## Request

```bash theme={null}
curl -X PATCH https://api.series.hr/sessions/session_abc123/custom-roles/claim \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "UserId": "714760171",
    "RoleName": "Trainer",
    "SlotKey": "VACANT_0"
  }'
```

## Parameters

<ParamField path="sessionId" type="string" required>
  The session ID
</ParamField>

<ParamField body="UserId" type="string" required>
  The Roblox user ID of the user claiming the slot (must be a workspace member)
</ParamField>

<ParamField body="RoleName" type="string" required>
  The name of the custom role to claim
</ParamField>

<ParamField body="SlotKey" type="string" required>
  The slot key to claim (must be a vacant slot, e.g. `VACANT_0`, `VACANT_1`)
</ParamField>

## Response

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "message": "Successfully claimed Trainer position",
      "SessionId": "session_abc123",
      "RoleName": "Trainer",
      "UserId": "714760171"
    }
  }
  ```
</ResponseField>

## Errors

| Status | Description                                                                                 |
| ------ | ------------------------------------------------------------------------------------------- |
| 400    | Session is not claimable, slot is already filled, or user already holds a slot in this role |
| 403    | Premium/Enterprise subscription required, or user does not meet minimum rank requirement    |
| 404    | Session or custom role not found                                                            |


## OpenAPI

````yaml PATCH /sessions/{sessionId}/custom-roles/claim
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /sessions/{sessionId}/custom-roles/claim:
    patch:
      tags:
        - Sessions
      summary: Claim Custom Role
      description: >-
        Claim a vacant custom role slot in a session. Requires Premium or
        Enterprise subscription.
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
          description: The session ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - UserId
                - RoleName
                - SlotKey
              properties:
                UserId:
                  type: string
                  description: Roblox user ID of the user claiming the slot
                RoleName:
                  type: string
                  description: Name of the custom role to claim
                SlotKey:
                  type: string
                  description: The vacant slot key (e.g. VACANT_0, VACANT_1)
      responses:
        '200':
          description: Custom role claimed successfully
        '400':
          description: Validation error (not claimable, slot filled, etc.)
        '403':
          description: Premium/Enterprise subscription required or rank requirement not met
        '404':
          description: Session or role not found
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````