Endpoint: roles

/roles/add

POST /api/v1/roles/add.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Add a new role.

Authentication: required

Parameters

Parameter Type Description
Name string The name of the role
Description string Description of this role
Permissions array The permissions of the role. Each global permission is a dot-separated key with a boolean value.
Permissions.Category array Custom category permissions. Each item in the array is a permission for a particular category. Note that the category must be configured to have custom permissions to be viable in this array.
Permissions.Category.CategoryID integer The ID of the category to set the permission for.
Permissions.Category.* boolean Each custom category permission is a dot-separated key with a boolean value.

/roles/edit

POST /api/v1/roles/edit.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Edit a role.

Authentication: required

Parameters

Parameter Type Description
RoleID RoleID The ID of the role to edit.
Name string The name of the role
Description string Description of this role
Permissions array The permissions to the role. See roles/add.

/roles/list

GET /api/v1/roles/list.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Get all of the roles.

Authentication: required

/roles/get

GET /api/v1/roles/get.ext?roleid=123 HTTP/1.1
Host: https://yoursite.vanillaforums.com

Get a single role.

Authentication: required

Parameters

Parameter Type Description
RoleID RoleID The ID of the role to get.

Cloud Hosting

We believe that online communities should be intuitive, engaging and true to your brand.

Learn more