Add to Queue
This endpoint allows you to add a user to the queue by submitting the required and optional details in the request body. Below are the details on how to use the /v1/queue/add
endpoint.
🛠 Endpoint
The following parameters can be included in the request body
Field | Type | Required | Description |
---|---|---|---|
steam_id | string | Yes | The Steam ID of the user being added to the queue. |
app_id | number | No | The application ID (if applicable). |
method | string | No | Must be either 'basic' or 'advanced' . |
reason | string | No | Must be either 'community' or 'cheating' . |
match_id | string | No | The match ID associated with the report. |
post_url | string | No | A valid URL related to the report (e.g., post or media link). |
custom_reason | string | No | A custom reason for the report (max 120 characters). |
Example Request:
🚀 Response
Upon successfully adding a user to the queue, the API will return a 200 OK
response with the following structure:
Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Indicates whether the request was successful (true or false ). |
message | string | A message confirming that the user was added to the queue. |
data.id | string | The unique identifier of the report. |
data.target.steam_id | string | The Steam ID of the reported user. |
data.target.name | string | The display name of the reported user. |
data.target.avatar | string | The avatar URL of the reported user. |
data.position | number | The position of the user in the queue. |
⚠️ Error Handling
If the request fails due to a missing required field or an invalid parameter, the response will look like this:
Ensure that all required fields (steam_id
) are provided and optional fields (if included) meet their validation criteria.