Skip to main content

Assign Many Users to a Group

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint​

/i/groups/save-many-user-group

Overview​

Bulk-assigns many users (by email list) to one group.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Required access: global admin

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication
argsObject (JSON string)YesStringified bulk assignment object

args Object Fields​

FieldTypeRequiredDescription
emailsArrayYesUser email list
group_idStringYesTarget group ID

Examples​

Example: Assign Many Users​

Endpoint form:

https://your-server.com/i/groups/save-many-user-group?api_key=YOUR_API_KEY&args={"emails":["a@example.com","b@example.com","c@example.com"],"group_id":"507f1f77bcf86cd799439011"}

Decoded args object:

{
  "emails": [
    "a@example.com",
    "b@example.com",
    "c@example.com"
  ],
  "group_id": "507f1f77bcf86cd799439011"
}

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringOperation status

Error Responses​

HTTP StatusResponse
200{ "result": "Not enough args" }
400{ "result": "Users not found" }
400{ "result": "Cannot add Global Admin to group" }
400{ "result": "Group not found" }
400{ "result": "Missing parameter \"api_key\" or \"auth_token\"" }

Behavior​

  1. Validates emails and group_id.
  2. Loads target users and group.
  3. Merges each user permission with group permission.
  4. Updates users in bulk and updates group member list.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersEndpoint data source** - Bulk update target
countly.groupsEndpoint data source** - Group member list update target