collaborators

Update Account Level Access

Adds or removes account level access to a collaborator with the given email address. Account level access allows a collaborator to be added to all new sites created under the site's owner, the collaborator will be automatically added with the permissions send as part of the request.

put/collaborators/update-account-level-access

Request

Request body

emailstring
add_to_all_newboolean
create_siteboolean
manage_tagsboolean
manage_ssoboolean
account_notificationsboolean
site_management_notificationsboolean
site_operation_notificationsboolean
account_administratorboolean
view_usageboolean
view_reportsboolean
manage_billingboolean
manage_emailboolean
delegate_email_notification_capabilitiesboolean
rolesstring[]

Response

Successful Response

messagestring
dataobject

Example response

{
  "message": "Success",
  "data": {
    "email": "johndoe@example.com",
    "account_administrator": true,
    "add_to_all_new": false,
    "create_site": false,
    "manage_tags": false,
    "manage_sso": false,
    "view_usage": false,
    "view_reports": false,
    "manage_billing": false,
    "manage_email": false,
    "delegate_email_notification_capabilities": false,
    "account_notifications": false,
    "site_management_notifications": false,
    "site_operation_notifications": false,
    "effective_capabilities": {
      "account_administrator": true,
      "add_to_all_new": false,
      "create_site": true,
      "manage_tags": true,
      "manage_sso": true,
      "view_usage": true,
      "view_reports": true,
      "manage_billing": true,
      "manage_email": true,
      "delegate_email_notification_capabilities": true,
      "account_notifications": false,
      "site_management_notifications": false,
      "site_operation_notifications": false
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.