Permission Scopes

📘

The optional parameter scope accepts a comma separated list of permission scopes. The permission scopes used for this parameter must be part of the set specified in the underlying API credential. If scope is not present in the request, the token will inherit all permission scopes associated with the API credential. A full list of permission scopes can be found below.

Entity NamePermission Scopes
Category TagCATEGORYTAG_READ, CATEGORYTAG_WRITE, CATEGORYTAG_DELETE
CommentsCOMMENT_READ
Company DetailsCOMPANY_READ, COMPANY_WRITE
ContactCONTACT_READ, CONTACT_WRITE, CONTACT_DELETE
Contact GroupCONTACTGROUP_READ, CONTACTGROUP_WRITE, CONTACTGROUP_DELETE
DocumentDOCUMENT_READ
EventEVENT_READ
Job ReferenceJOBREFERENCE_READ, JOBREFERENCE_WRITE, JOBREFERENCE_DELETE
KeywordKEYWORD_READ, KEYWORD_WRITE, KEYWORD_DELETE,
MessageMESSAGE_READ, MESSAGE_WRITE, MESSAGE_DELETE
Quarantine MessageQUARANTINED_MESSAGE_READ, QUARANTINED_MESSAGE_WRITE
Saved SearchSAVEDSEARCH_READ, SAVEDSEARCH_WRITE, SAVEDSEARCH_DELETE
TeamTEAM_READ, TEAM_WRITE, TEAM_DELETE
TemplateTEMPLATE_READ
UsersUSER_READ, USER_WRITE, USER_DELETE
WorkflowsWORKFLOW_READ, WORKFLOW_WRITE, WORKFLOW_DELETE