Add a Promotion

You can create a new Promotion for one of your applications on Aptoide Connect via the Developer Console or our API as described below.

Endpoint

Method	URL
POST	https://ws.catappult.io/api/promotions

Authentication

To access this API, you need to have an active account subscription on Aptoide Connect and authenticate with an API key (check here how to generate one).

⚠️

Account type required

Promotions can only be created, edited, or deleted by accounts of type Partner.

Headers

Header	Type	Required	Description
Api-Key	string	Required	Used to authenticate your API requests. The value is your Aptoide Connect API key.

Body Parameters

The endpoint accepts either application/json or multipart/form-data. File uploads require multipart/form-data.

Parameter	Type	Required	Description
applicationName	string	Required	The unique package name of the application the promotion belongs to (e.g. com.example.test).
name	string	Required	Display name of the promotion.
type	string	Required	Promotion type (e.g. SEARCH).
description	string	Optional	Free-text description of the promotion.
eventUid	string	Optional	UUID of an existing Event to link this promotion to. When set, the created promotion's event field will reference that event.
startTimestamp	string	Optional	Promotion start date/time. Format: YYYY-MM-DD HH:mm:ss.
endTimestamp	string	Optional	Promotion end date/time. Format: YYYY-MM-DD HH:mm:ss.
files[<index>]	file	Optional	Image files showcasing how the promotion looks (e.g. screenshots or banner assets), sent as multipart/form-data. Use indexed keys ([0], [1], …) to upload multiple images.

Examples

Creating a promotion via JSON

curl -X POST "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationName": "com.example.test",
    "name": "Spring Promotion",
    "type": "SEARCH",
    "startTimestamp": "2027-01-01 00:00:00",
    "endTimestamp": "2027-01-02 00:00:00"
  }'

Creating a promotion with asset files via multipart/form-data

curl -X POST "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "applicationName=com.example.test" \
  -F "name=Spring Promotion" \
  -F "type=SEARCH" \
  -F "startTimestamp=2027-01-01 00:00:00" \
  -F "endTimestamp=2027-01-02 00:00:00" \
  -F "files[0]=@/path/to/asset-1.png" \
  -F "files[1]=@/path/to/asset-2.png"

Response

Success

If the API call returns an HTTP 200 status code, the request was successful and the promotion has been created. The response body is the newly created promotion's uid (a UUID string).

Example Response

"9dbf70ff-30a4-4d82-b062-42ab24126e59"