Remove Users from a Sales Group

Removes multiple users from a sales group.

  • The “GroupId” parameter is mandatory. You can retrieve it using the Get Sales Groups API
  • The “UserIds” parameter is also mandatory. You can pass multiple user Ids to remove multiple users from a group at a go.
  • You can optionally pass a “CallbackURL” parameter to specify a URL you want to post the API response to.

Note: The processing for this API is Async.

API URL

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

Request

JSON Body/Payload

Content-Type: application/json

{
  "GroupId": "ed3ea545-b1fa-11e9-9371-0666b2d6ef5e",
  "UserIds": [
    "0020de63-c5fd-11e7-b4ec-069729b2474c",
    "0040te43-c8fe-12e2-b2wc-096229f2533d"
  ],
  "CallbackURL": "https://webhook.site/0317f42b-d236-442e-829a1411c558a893"
}

JSON Properties

Parameter Description
GroupId

The unique identifier of the sales group.

UserIds

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

CallbackURL

You can pass a custom URL where you want to post the API response.

Response

200 OK

Content-Type: application/json

{
  "Status": "Success",
  "Response": {
    "RequestType": "Remove 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.