API ReferenceSecurity

Create Business Role

Chargebee entitlements are evaluated read-only when saving permission grants; this call does not change subscription state.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

Role name, optional description, and permission settings for the new role.
namestringOptional

Display name of the new custom role; must not duplicate another role name in the workspace (case-insensitive).

descriptionstring or nullOptional

Optional description; must not match reserved system role description tokens.

permissionsobjectOptional

Workspace permissions for the new role. Same property names as RetrieveMe; true/false per flag. Omitted or null properties are treated as off. ChangeOwnEmail is not modeled here and defaults to off for new custom roles.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject

Workspace business role returned by the data API security endpoints (list/update responses and create response).