GEgetbrevo
Master account

Send invitation to an admin user

Changed on

`This endpoint allows you to invite a member to manage the Admin account

Features and their respective permissions are as below:

  • my_plan:
    • "all"
  • api:
    • "none"
  • user_management:
    • "all"
  • app_management | Not available in ENTv2:
    • "all"

Note:

  • If all_features_access: false then only privileges are required otherwise if true then it's assumed that all permissions will be there for the invited admin user.
post/corporate/user/invitation/send

Request

Request body

emailstring email required

Email address for the organization

all_features_accessboolean required

All access to the features

groupIdsstring[]

Ids of Group

Example request

{
  "email": "inviteuser@example.com",
  "groupIds": [
    "2baxxxxxxxxxxxxxxxxxxxxxcaa",
    "65axxxxxxxxxxxxxxxxxxxxxc5a"
  ],
  "privileges": [
    {
      "feature": "user_management",
      "permissions": [
        "'all', 'none'"
      ]
    }
  ]
}

Response

Success

emailstring email required

Email address for the organization

all_features_accessboolean required

All access to the features

groupIdsstring[]

Ids of Group

Example response

{
  "email": "inviteuser@example.com",
  "groupIds": [
    "2baxxxxxxxxxxxxxxxxxxxxxcaa",
    "65axxxxxxxxxxxxxxxxxxxxxc5a"
  ],
  "privileges": [
    {
      "feature": "user_management",
      "permissions": [
        "'all', 'none'"
      ]
    }
  ]
}

Changes