Remove user from groups

POST {{baseUrl}}/api/v1/users/:user_id/groups/dissociate?groupIds=<list>

This API removes a user from the groups specified.

OAuth Scope

  • Desk.contacts.UPDATE
  • Desk.settings.UPDATE

Request Params

KeyDatatypeRequiredDescription
helpCenterIdstringID of the help center from which the groups must be removed
groupIdsstringIDs of the groups from which the user must be removed

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;results&quot;:[{&quot;success&quot;:false,&quot;id&quot;:&quot;24073000002957051&quot;,&quot;errors&quot;:{&quot;errorCode&quot;:&quot;FORBIDDEN&quot;,&quot;httpCode&quot;:403,&quot;error&quot;:&quot;Minimum user should be maintained&quot;}},{&quot;success&quot;:false,&quot;id&quot;:&quot;24073000002932512&quot;,&quot;errors&quot;:{&quot;errorCode&quot;:&quot;FORBIDDEN&quot;,&quot;httpCode&quot;:403,&quot;error&quot;:&quot;Restricted&quot;}},{&quot;success&quot;:true,&quot;id&quot;:&quot;24073000002953232&quot;,&quot;errors&quot;:null}]}