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

# Bindings

> Read and manage the role bindings that map Roblox data to Discord roles.

Bindings assign Discord roles from Roblox data. These endpoints let you read the configured bindings and manage them programmatically. For the concept and the dashboard UI, see [Bindings](https://technified.mintlify.site/dashboard/roblox/bindings.md).

`list` reads the guild from the `X-Guild-ID` header. The write endpoints take `guild_id` in the body.

## Binding types

| `binding_type` | Required fields |
| - | - |
| `group_rank` | `roblox_group_id`, `min_rank`, `max_rank` (ranks 0 to 255) |
| `gamepass` | `roblox_gamepass_id` |
| `asset` | `roblox_asset_id` |
| `badge` | `roblox_badge_id` |
| `account_age` | `account_age_platform`, `account_age_min_days` |

## List bindings

```http theme={null}
GET /bindings/list
```

**X-Guild-ID** `string` *required*

The guild to read. Must match your key's guild.

Each binding is enriched with the resolved Discord role name and, for group bindings, the Roblox group name.

**data** `object`

**binding properties**

**id** `number`

**discord\_role\_id** `string`

**discord\_role\_name** `string`

**binding\_type** `string`

**roblox\_group\_id** `number | null`

**roblox\_group\_name** `string`

**min\_rank** `number | null`

**max\_rank** `number | null`

**gamepass\_id** `number | null`

```bash cURL theme={null}
curl "https://api.technified.xyz/api/v1/bindings/list" \
  -H "X-API-Key: $TECHNIFIED_API_KEY" \
  -H "X-Guild-ID: $GUILD_ID"
```

## Add a binding

```http theme={null}
POST /bindings/add
```

**guild\_id** `string` *required*

**discord\_role\_id** `string` *required*

The Discord role to assign.

**binding\_type** `string` *required*

One of `group_rank`, `gamepass`, `asset`, `badge`, `account_age`.

**roblox\_group\_id** `number`

Required for `group_rank`.

**min\_rank** `number`

Required for `group_rank`. 0 to 255.

**max\_rank** `number`

Required for `group_rank`. Must be at least `min_rank`.

**roblox\_gamepass\_id** `number`

Required for `gamepass`.

**roblox\_asset\_id** `number`

Required for `asset`.

**roblox\_badge\_id** `number`

Required for `badge`.

**account\_age\_platform** `string`

`discord` or `roblox`. Required for `account_age`.

**account\_age\_min\_days** `number`

Required for `account_age`.

**priority** `number`

Optional ordering hint when bindings overlap.

The Roblox group, gamepass, asset, or badge is validated against Roblox before the binding is saved. An invalid ID returns `400`.

```bash Group rank theme={null}
curl "https://api.technified.xyz/api/v1/bindings/add" \
  -H "X-API-Key: $TECHNIFIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "guild_id": "'$GUILD_ID'",
    "discord_role_id": "111111111111111111",
    "binding_type": "group_rank",
    "roblox_group_id": 1200769,
    "min_rank": 50,
    "max_rank": 99
  }'
```

```bash Gamepass theme={null}
curl "https://api.technified.xyz/api/v1/bindings/add" \
  -H "X-API-Key: $TECHNIFIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "guild_id": "'$GUILD_ID'",
    "discord_role_id": "222222222222222222",
    "binding_type": "gamepass",
    "roblox_gamepass_id": 123456
  }'
```

## Update a binding

```http theme={null}
PATCH /bindings/update
```

**binding\_id** `number` *required*

**min\_rank** `number`

**max\_rank** `number`

**priority** `number`

## Remove a binding

```http theme={null}
DELETE /bindings/remove/:bindingId
```

**bindingId** `number` *required*

The `id` of the binding to delete.

## Test a binding against a user

Check whether a specific verified member would match an existing group binding. Useful for debugging "why does this person not have the role".

```http theme={null}
POST /bindings/test
```

**guild\_id** `string` *required*

**discord\_id** `string` *required*

The member to test. Must be verified in the guild.

**binding\_id** `number` *required*

The binding to test against.

**data.matches** `boolean`

**data.reason** `string`

A human-readable explanation, for example "User rank 12 is below minimum 50".

**data.user\_rank** `number`

The member's rank in the group, when applicable.

```json 200 theme={null}
{
  "status": "success",
  "code": 200,
  "message": "Binding test complete",
  "data": {
    "matches": false,
    "reason": "User rank 12 is below minimum 50",
    "user_rank": 12
  }
}
```

## Validate a group binding config

Check a group rank configuration before saving it. This validates the group exists and the ranks are sane. It is group-rank specific.

```http theme={null}
POST /bindings/validate
```

**roblox\_group\_id** `number` *required*

**min\_rank** `number`

0 to 255.

**max\_rank** `number`

0 to 255, and at least `min_rank`.

```json 200 theme={null}
{
  "status": "success",
  "code": 200,
  "message": "Binding configuration is valid",
  "data": {
    "valid": true,
    "group_name": "Acme Corp",
    "group_id": 1200769
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.