Skip to main content
POST
/
device
/
{app_id}
Track Device
curl --request POST \
  --url https://api-0{dc}.moengage.com/v1/device/{app_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "device",
  "customer_id": "<string>",
  "device_id": "<string>",
  "attributes": {
    "platform": "ANDROID",
    "push_id": "<string>",
    "model": "<string>",
    "moe_push_opted": "True",
    "moe_push_provisional_opted": "<string>",
    "app_version": "<string>",
    "os_version": "<string>",
    "moe_gaid": "<string>",
    "idfv": "<string>"
  }
}
'
{
  "status": "success",
  "message": "Your request has been accepted and will be processed soon."
}

​
Rate Limit

A single API request contains one or more device updates. Maintain a rate limit of 10,000 device updates per minute..

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Data tile.

Note: After you generate and save the Data API Key, DO NOT generate a new key unless there is a security breach. After you generate a different Data API key and save it, the authentication will start failing. You must update your existing data tracking.

For more information on authentication and getting your credentials, refer here.

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

​
app_id
string
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).

Example:

"VJ0GSMESHMQA3L7WV1EEK3UR"

Body

application/json
​
type
enum<string>
required

This field denotes the type of request. Supported value is: device. This field is case-sensitive. When passing the value in the request, follow the case as in the example.

Available options:
device
​
customer_id
string
required

This field denotes the unique identifier used to identify a user in MoEngage. Note that devices can be created for existing users only.

​
device_id
string
required

This field denotes the unique identifier used to identify the device associated with a user in MoEngage. If your app is integrated with MoEngage SDK, the SDK assigns a unique device_id to the devices of your end-users. If your app is not integrated with MoEngage SDK, you can use unique alphanumeric values or other device attributes such as Push token, GAID/IDFV to assign unique device_id values to devices of your user.

​
attributes
object
required

This field contains the device attributes to add or update in the device profile.

Response

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