Skip to main content
POST
/
devices
/
manage
Device Opt-out
curl --request POST \
  --url https://api-0{dc}.moengage.com/v1/devices/manage \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_identifier_type": "<string>",
  "user_identifier_value": "<string>",
  "action_type": "block",
  "reason": "<string>",
  "client_reference_id": "<string>",
  "device_identifiers": [
    {
      "GAID": "<string>",
      "IDFV": "<string>",
      "unique_id": "<string>",
      "device_unique_id": "<string>",
      "push_id": "<string>"
    }
  ]
}
'
{
  "status": "success",
  "message": "Your request has been accepted and will be processed soon."
}

​
Rate Limit

The rate limit is 1000 API requests 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.

Query 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).

Body

application/json
​
user_identifier_type
string
required

This field denotes the type of user identifier.

​
user_identifier_value
string
required

This field denotes the user identifier.

​
action_type
enum<string>
required

This field denotes the type of action to be achieved using this API.

Available options:
block,
unblock
​
reason
string

This field denotes the reason for blocking or unblocking a device.

​
client_reference_id
string

This field denotes the reference ID of the user.

​
device_identifiers
object[]

This field denotes the device identifiers associated with the device you intend to block or unblock. Supported values are:

  • unique_id (unique_id)
  • device_unique_id (device_id)
  • push_id (push_id)
  • moe_gaid (GAID)

Note:

  • If you do not pass this value, the API blocks/unblocks all current devices of the user.
  • Ensure to pass any one of the device identifiers for a particular device.
  • When passing the device identifiers within the array, ensure to explicitly define each of them.

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