Skip to main content

Assign Many Users to a Group

Endpoint​

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

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

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

Authentication​

  • Authentication methods:
    • API Key (parameter): api_key=YOUR_API_KEY
    • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
    • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

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

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/Processing​

  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.

Database Collections​

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

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"
}

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions

Last Updated​

2026-02-16