Create a role
Creates a custom role with a set of permission keys. To list valid keys, call GET /api/v1/permissions. To grant ADMINISTRATOR, you must hold it yourself.
Permission required: MANAGE_WORKSPACE_ROLES on the workspace.
Authorizations
Headers
ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Body
Body
Create a workspace role
Permission keys to grant. To list valid keys, call GET /api/v1/permissions.
A workspace permission key, e.g. "READ_DOCUMENT" or "SEND_DOCUMENT"
READ_DOCUMENT, CREATE_DOCUMENT, EDIT_DOCUMENT, DELETE_DOCUMENT, SEND_DOCUMENT, APPROVE_DOCUMENT, EDIT_AFTER_SEND, SEND_WITHOUT_APPROVAL, WITHDRAW_DOCUMENT, VIEW_SAJN_ID, MANAGE_SAJN_ID, VIEW_PRIVATE_DOCUMENT, READ_FILE, CREATE_FILE, DELETE_FILE, CHANGE_DOCUMENT_VISIBILITY, READ_CONTACT, CREATE_CONTACT, DELETE_CONTACT, MANAGE_WORKSPACE_MEMBERS, MANAGE_WORKSPACE_ROLES, MANAGE_WORKSPACE_SETTINGS, MANAGE_FORM, DELETE_FORM, READ_FORM_SUBMISSIONS, CREATE_TEMPLATE, UPDATE_TEMPLATE, DELETE_TEMPLATE, RESTORE_TEMPLATE, PERMANENTLY_DELETE_TEMPLATE, VIEW_PRIVATE_TEMPLATE, CHANGE_TEMPLATE_VISIBILITY, CREATE_TAG, UPDATE_TAG, DELETE_TAG, CREATE_CUSTOM_FIELD, UPDATE_CUSTOM_FIELD, DELETE_CUSTOM_FIELD, UPDATE_FILE, UPDATE_CONTACT, MANAGE_AI_SETTINGS, USE_AI_CHAT, USE_AI_DOCUMENT_GENERATION, USE_AI_TEXT_ENHANCEMENT, READ_DOCUMENT_AUDIT_LOG, PERMANENTLY_DELETE_DOCUMENT, RESTORE_DOCUMENT, FORCE_COMPLETE_DOCUMENT, READ_COMMENT, CREATE_COMMENT, UPDATE_COMMENT, DELETE_COMMENT, IMPORT_CONTACTS, EXPORT_CONTACTS, MANAGE_CONTACT_NOTES, LOCK_TEMPLATE, READ_REPORT, CREATE_REPORT, UPDATE_REPORT, DELETE_REPORT, CREATE_BULK_SEND, CREATE_PRODUCT, UPDATE_PRODUCT, DELETE_PRODUCT, MANAGE_API_TOKENS, MANAGE_WEBHOOKS, AUTHORIZE_OAUTH_APP, MANAGE_DEVELOPER, CREATE_FOLDER, UPDATE_FOLDER, DELETE_FOLDER, LOCK_SECTION, ADMINISTRATOR Response
Workspace role
Workspace role
Permission keys granted by this role
A workspace permission key, e.g. "READ_DOCUMENT" or "SEND_DOCUMENT"
READ_DOCUMENT, CREATE_DOCUMENT, EDIT_DOCUMENT, DELETE_DOCUMENT, SEND_DOCUMENT, APPROVE_DOCUMENT, EDIT_AFTER_SEND, SEND_WITHOUT_APPROVAL, WITHDRAW_DOCUMENT, VIEW_SAJN_ID, MANAGE_SAJN_ID, VIEW_PRIVATE_DOCUMENT, READ_FILE, CREATE_FILE, DELETE_FILE, CHANGE_DOCUMENT_VISIBILITY, READ_CONTACT, CREATE_CONTACT, DELETE_CONTACT, MANAGE_WORKSPACE_MEMBERS, MANAGE_WORKSPACE_ROLES, MANAGE_WORKSPACE_SETTINGS, MANAGE_FORM, DELETE_FORM, READ_FORM_SUBMISSIONS, CREATE_TEMPLATE, UPDATE_TEMPLATE, DELETE_TEMPLATE, RESTORE_TEMPLATE, PERMANENTLY_DELETE_TEMPLATE, VIEW_PRIVATE_TEMPLATE, CHANGE_TEMPLATE_VISIBILITY, CREATE_TAG, UPDATE_TAG, DELETE_TAG, CREATE_CUSTOM_FIELD, UPDATE_CUSTOM_FIELD, DELETE_CUSTOM_FIELD, UPDATE_FILE, UPDATE_CONTACT, MANAGE_AI_SETTINGS, USE_AI_CHAT, USE_AI_DOCUMENT_GENERATION, USE_AI_TEXT_ENHANCEMENT, READ_DOCUMENT_AUDIT_LOG, PERMANENTLY_DELETE_DOCUMENT, RESTORE_DOCUMENT, FORCE_COMPLETE_DOCUMENT, READ_COMMENT, CREATE_COMMENT, UPDATE_COMMENT, DELETE_COMMENT, IMPORT_CONTACTS, EXPORT_CONTACTS, MANAGE_CONTACT_NOTES, LOCK_TEMPLATE, READ_REPORT, CREATE_REPORT, UPDATE_REPORT, DELETE_REPORT, CREATE_BULK_SEND, CREATE_PRODUCT, UPDATE_PRODUCT, DELETE_PRODUCT, MANAGE_API_TOKENS, MANAGE_WEBHOOKS, AUTHORIZE_OAUTH_APP, MANAGE_DEVELOPER, CREATE_FOLDER, UPDATE_FOLDER, DELETE_FOLDER, LOCK_SECTION, ADMINISTRATOR 
