Marketing API - Activation Reporting

This API is designed for specific performance-based campaigns in cooperation with selected app stores. If you are unsure whether your app needs to integrate this API, please contact your support manager.

This API is used to report app activation events for performance-based marketing campaigns. When the expected events triggered in the app, it calls this API to notify our server of the activation. We then synchronize the activation data with selected marketing partners or app stores to verify campaign results and track user acquisition effectiveness.

Endpoint

POST https://api.appconnect.cn/marketing/activation

Headers

Header	Value	Required	Description
Content-Type	application/json	Yes	Request body must be JSON
Accept	application/json	Yes	Only JSON responses allowed

Request Parameters (JSON Body)

Field	Type	Required	Description
appid	string	Yes	App identifier to distinguish which app is reporting
oaid	string	Yes	Device OAID (Open Anonymous ID)
androidid	string	Yes	Android ID of the device
imei	string	Conditional	Required if Android version < 10; optional for Android 10 and above
os	string	Yes	Operating system (e.g. Android 11)
channel	string	Yes	App distribution channel (e.g. oppo/vivo/xiaomi)
timestamp	number	Yes	Client-reported Unix timestamp in milliseconds
extra	object	No	Optional extra data (must be a JSON object)

Note:

The imei field is required if the device is running Android 9 or below.

Do not modify the original User-Agent header when sending the request. It must reflect the actual device and app environment.

Response Parameters (JSON Body)

Parameter	Type	Description
code	number	Response code: 0 for success, 1 for already activated, HTTP status codes for other errors
message	string	Description of the result or error
data	string	On success: { "id": "uuid" }, containing the ID of the recorded activation; On error: Contains a map of invalid fields and their error reasons

Example Request

{
  "appid": "123456789-1234-5678-9012-123456789012",
  "oaid": "1234567890abcdef",
  "androidid": "9774d56d682e549c",
  "imei": "860123456789012",
  "os": "Android 11",
  "channel": "vivo",
  "timestamp": 1714480005123, 
  "extra": {
  }
}

Success Response

{
    "code": 0,
    "message": "Activation recorded",
    "data": {
        "id": "3c2db693-d75b-4dda-a642-7564fd71a268"
    }
}

{
    "code": 1,
    "message": "Already activated",
    "data": {
        "id": "3c2db693-d75b-4dda-a642-7564fd71a268"
    }
}

Validation Error Response

{
  "code": 422,
  "message": "Validation failed",
  "data": {
    "oaid": ["The oaid field is required."],
    "appid": ["The appid field is required."]
  }
}

Authentication

Not required. This endpoint is public.

Contact Us

Feel free to contact your support manager or contact us via our online form when you need any help.

Custom Solutions

Recent posts