MOmoengage
Update Campaigns

Update Global Control Group

This API adds or removes users from the Global Control Group (GCG) in MoEngage. Provide a publicly accessible CSV of user IDs and specify whether to add or remove those users.

put/global-control-group/users

Request

Headers

MOE-APPKEYstring required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Request body

request_idstring required

Unique identifier of the request to update the Global Control Group.

file_urlstring uri required

Publicly accessible URL of the CSV file for processing. The file must contain a single column named uid followed by the respective user IDs in new rows. The file must be under 300 MB and downloadable without authentication.

Note: Currently, only publicly accessible Amazon S3 URLs are supported.

action_type'add' | 'remove' required

The operation to perform on users in the Global Control Group.

updated_bystring email required

The email ID of the user initiating the update.

Example request

{
  "request_id": "{{request_id}}",
  "file_url": "https://example.csv",
  "updated_by": "john.doe@xyz.com"
}

Response

No Content - The request was processed successfully. There is no response body.

Changes

No recorded changes to this operation across all 1 revision of this API.