Bulk Import Users and Events

Use the Bulk Import API to send, to MoEngage, in batch multiple user and event requests using a single API request. You can send a batch request of a maximum of 100 kB in a single API call.

POST /transition/{Workspace_ID}

cURL

sample_cURL

curl --request POST \ --url https://api-0{dc}.moengage.com/v1/transition/{Workspace_ID} \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "type": "transition", "elements": [ { "type": "customer", "customer_id": "AZ8TM", "attributes": { "name": "qjDKn", "first_name": "xSEdd", "last_name": "UWbah", "platforms": [ { "platform": "iOS", "active": "true" } ] } }, { "type": "customer", "customer_id": "9yt8q8", "attributes": { "name": "5Np", "first_name": "2irjN", "last_name": "CH4Zo", "platforms": [ { "platform": "ANDROID", "active": "true" } ] } }, { "type": "customer", "customer_id": "ONfYcF", "attributes": { "name": "U92", "first_name": "zgI63", "last_name": "Dle4b", "platforms": [ { "platform": "web", "active": "true" } ] } }, { "type": "device", "customer_id": "AZ8TM", "device_id": "AZ8TM", "attributes": { "brand": "{{model_bulk1}}", "platform": "{{platform_bulk1}}", "push_id": "pushid1991" } }, { "type": "device", "customer_id": "9yt8q8", "device_id": "9yt8q8", "attributes": { "brand": "{{model_bulk1}}", "platform": "{{platform_bulk1}}", "push_id": "pushid2744" } }, { "type": "device", "customer_id": "ONfYcF", "device_id": "ONfYcF", "attributes": { "brand": "{{model_bulk1}}", "platform": "{{platform_bulk1}}", "push_id": "pushid3546" } }, { "type": "event", "customer_id": "ONfYc", "actions": [ { "action": "A6CO5", "attributes": { "product": "Shirt" }, "platform": "{{platform_bulk1}}", "app_version": "839", "user_time": "1712567385726", "current_time": "1712567385726" }, { "action": "wuDX8", "attributes": { "product": "MacBook Air", "brand": "Apple" }, "platform": "iOS", "app_version": "1.2.3", "user_time": "1712567385726", "current_time": "1712567385726" } ] }, { "type": "event", "customer_id": "9yt8q8", "actions": [ { "action": "A6CO5", "attributes": { "product": "Shirt" }, "platform": "{{platform_bulk1}}", "app_version": "1.2.3", "user_time": "1712567385726", "current_time": "1712567385726" }, { "action": "Purchase", "attributes": { "product": "MacBook Air", "brand": "Apple" }, "platform": "iOS", "app_version": "1.2.3", "user_time": "1712567385726", "current_time": "1712567385726" } ] }, { "type": "event", "customer_id": "ONfYcF", "actions": [ { "action": "A6CO5", "attributes": { "product": "Shirt" }, "platform": "{{platform_bulk1}}", "app_version": "1.2.3", "user_time": "1712567385726", "current_time": "1712567385726" }, { "action": "Purchase", "attributes": { "product": "MacBook Air", "brand": "Apple" }, "platform": "iOS", "app_version": "1.2.3", "user_time": "1712567385726", "current_time": "1712567385726" } ] } ] } '

200

success_response

{ "status": "success", "message": "Your request has been accepted and will be processed soon." }

All bulk API requests return a 200 response code. Debugging should be done on the user profile on the dashboard.

Example Payload

To view the sample API request, select example_payload from dropdown.

Array Support

To view the appropriate syntax to pass an attribute in an array, select array_support from the dropdown

User Identity Resolution

In MoEngage, data ingestion uses an ID to create or update a user. For workspaces in MoEngage with Identity Resolution enabled, Bulk Import API can be used to create or update users using a specific identifier, such as a mobile number or email ID, these identifiers need to be enabled for the workspace in Identity Resolution dashboard. You can:

• Create users through Server-to-Server Data APIs even when they do not have an ID (but have other identifiers).
• Create a user or track events of a user when identifiers other than ID (for example, email ID or phone number) are known.

Types of Payload in Request Body

The sample cURL request for a Bulk Import API consisting of the following payloads:

• User payload: Attribute parameters must contain at least one of the identifiers you have configured based on which users in MoEngage will be created, updated, or merged.
• Event payload: Identifiers set up in the workspace must be mentioned within the user_identifiers parameter, as shown in the below example where moe_mobile is one of the identifiers in the workspace:

"user_identifiers":{
"moe_mobile":"{{Mobile_Number}}"
}

To view the Bulk Import API that consists of payloads for users and events, select user_identity_resolution from the dropdown.

Authorizations

Authorization · string · header · required

This authentication parameter, used for access control, must be passed along with the request. The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization: Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

The username and password details can be obtained from the MoEngage Dashboard. If you're using the API for the first time, follow these steps:

1. Navigate to Settings -> Account -> APIs.
2. Copy the following details:
   • Username: Under Workspace ID (earlier app id), click the copy icon to copy the username.
   • Password: In the API keys section, click the copy icon in the Data tile to copy the API key.

Use these details to authenticate the API requests.

Headers

X-Forwarded-For · string

The 'X-Forwarded-For' header is used to specify the IP address of the client that made the request. This header may be added by proxy servers or load balancers. The header value must contain the IP address of the original client that initiated the request. Multiple IP addresses may be specified in the header value, separated by commas.

Example:

"203.0.113.195"

Path Parameters

Workspace_ID · string · required

This is the Workspace ID of your MoEngage account that has to be passed along with the request. You can find your MoEngage Workspace ID at Settings > Account > APIs > Workspace ID (earlier app id).''

Body

application/json

type · enum<string> · required

This is used to identify the type of request. This field is case-sensitive. Follow the case as in the example when passing the value in the request.

Available options: transition

elements · (User · object | Event · object | Device · object)[] · required

List of data points (events and customers) to track. The type field in this list denotes whether the information is for a customer or an event. This field is case-sensitive. Follow the case as in the example when passing the value in the request.

User

Event

Device

Show child attributes

Response

200

application/json

This response is returned when the request is processed successfully.

status · string

This field contains the status of the request and specifies whether the request was successful.

Example:

"success"

message · string

Example:

"Your request has been accepted and will be processed soon."