Endpoints to manage custom roles. Custom roles allow you to tailor roles from individual permissions to match your needs. Once created, you can assign your custom roles to your merchant account members using the memberships.
Beta.
Objects:
- List rolesGET
/v0.1/merchants/{merchant_code}/rolesList merchant's custom roles.
OAuth scopes: Requires one of:
user.subaccounts,roles.read.Required permissions:
{"relation":"roles_list","object_type":"merchant","object_id_param":"merchant_code"}
- Create a rolePOST
/v0.1/merchants/{merchant_code}/rolesCreate a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.
OAuth scopes: Requires one of:
user.subaccounts,roles.write.Required permissions:
{"relation":"roles_create","object_type":"merchant","object_id_param":"merchant_code"}
- Retrieve a roleGET
/v0.1/merchants/{merchant_code}/roles/{role_id}Retrieve a custom role by ID.
OAuth scopes: Requires one of:
user.subaccounts,roles.read.Required permissions:
{"relation":"roles_view","object_type":"merchant","object_id_param":"merchant_code"}
- Delete a roleDELETE
/v0.1/merchants/{merchant_code}/roles/{role_id}Delete a custom role.
OAuth scopes: Requires one of:
user.subaccounts,roles.write.Required permissions:
{"relation":"roles_delete","object_type":"merchant","object_id_param":"merchant_code"}
- Update a rolePATCH
/v0.1/merchants/{merchant_code}/roles/{role_id}Updates a custom role's name, description, or permissions and returns the updated role.
Providing
permissionsreplaces the role's permission list and changes the access granted to members assigned to that role. Omitted fields remain unchanged.OAuth scopes: Requires one of:
user.subaccounts,roles.write.Required permissions:
{"relation":"roles_update","object_type":"merchant","object_id_param":"merchant_code"}