Add Users to a Sales Group

Lets you add multiple users to a sales group.

  • It is mandatory to pass the “GroupId”. You can retrieve it using the Get Sales Groups API.
  • It is also mandatory to pass the “UserId” for the users you want to add to the sales group.
  • You can assign the following permissions
    • “ViewAllAccountsOfGroup”
    • “ModifyAllAccountsOfGroup”
    • “ViewAllLeadsOfGroup”
    • “ModifyAllLeadsOfGroup”
    • “AddUsersToGroup”
    • “CreateGroupAutomation”

If even one permission is passed as true, the user will become a group manager. A sales group can have multiple group managers.

Note:

  • You can pass an optional “CallbackURL” to post the response data to a custom URL.
  • The processing for this API is Async.

 

API URL

POST
https://{host}/v2/UserGroup.svc/AddUsers?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
  "GroupId": "ed3ea545-b1fa-11e9-9371-0666b2d6ef5e",
  "GroupUsers": [
    {
      "UserId": "0403250f-7ab2-11e8-8266-06ee26114d5a",
      "ViewAllAccountsOfGroup": true,
      "ModifyAllAccountsOfGroup": true,
      "ViewAllLeadsOfGroup": true,
      "ModifyAllLeadsOfGroup": false,
      "AddUsersToGroup": false,
      "CreateGroupAutomation": false
    },
    {
      "UserId": "0591e181-7ab2-11e8-8266-06ee26114d5a",
      "ViewAllAccountsOfGroup": false,
      "ModifyAllAccountsOfGroup": false,
      "ViewAllLeadsOfGroup": false,
      "ModifyAllLeadsOfGroup": false,
      "AddUsersToGroup": false,
      "CreateGroupAutomation": false
    }
  ],
  "CallbackURL": "https://exaplewebhook.site/0317f42b-d236-442e-829a1411c558a893"
}

JSON Properties

Parameter Description
GroupId

Unique identifier of the sales group.
UserId

Unique identifier of the user. You can use the User Management APIs to retrieve the user Id.
ViewAllAccountsOfGroup

Gives the user access to accounts owned by all users in the group.
ModifyAllAccountsOfGroup

Allows the user to modify accounts owned by all users in the group.
ViewAllLeadsOfGroup

Gives the user view access to leads owned all users in the group.
ModifyAllLeadsOfGroup

Gives the user edit access to leads owned all users in the group.
AddUsersToGroup

Allows the user to add new users to the group.
CreateGroupAutomation

Gives the user permission to create group level automations.
CallbackURL

You can pass a custom URL where the response will be posted.

Response

200 OK

Content-Type: application/json

{
  "Status": "Success",
  "Response": {
    "RequestType": "Add Group Users",
    "RequestId": "2642b271-f7ba-4e47-8043-34154b10c913"
  }
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.
401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.
400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.
429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.