list reads the guild from the X-Guild-ID header. The write endpoints take guild_id in the body.
Binding types
List bindings
string
required
The guild to read. Must match your key’s guild.
object
Add a binding
string
required
string
required
The Discord role to assign.
string
required
One of
group_rank, gamepass, asset, badge, account_age.number
Required for
group_rank.number
Required for
group_rank. 0 to 255.number
Required for
group_rank. Must be at least min_rank.number
Required for
gamepass.number
Required for
asset.number
Required for
badge.string
discord or roblox. Required for account_age.number
Required for
account_age.number
Optional ordering hint when bindings overlap.
400.
Update a binding
number
required
number
number
number
Remove a binding
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”.string
required
string
required
The member to test. Must be verified in the guild.
number
required
The binding to test against.
boolean
string
A human-readable explanation, for example “User rank 12 is below minimum 50”.
number
The member’s rank in the group, when applicable.
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.number
required
number
0 to 255.
number
0 to 255, and at least
min_rank.