Add an Event

You can create a new Event 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/events

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

Events can only be created, edited, or deleted by accounts of type Developer.

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 event belongs to (e.g. com.example.test).
name	string	Required	Display name of the event.
type	string	Optional	Event type (e.g. CUSTOM). See List Available Event Types for valid values.
startTimestamp	string	Optional	Event start date/time. Format: YYYY-MM-DD HH:mm:ss.
endTimestamp	string	Optional	Event end date/time. Format: YYYY-MM-DD HH:mm:ss.
allowedPartners	string	Optional	Comma-separated list of partner identifiers (e.g. APTOIDE-GAMES,APTOIDE-VANILLA). See List Available Partners for valid values.
locales[<localeName>][description]	string	Optional	Short description for the given locale (e.g. en_GB).
locales[<localeName>][longDescription]	string	Optional	Long description for the given locale.
locales[<localeName>][files][<index>]	file	Optional	Asset file for the given locale, sent as multipart/form-data. Use indexed keys ([0], [1], …) to upload multiple files. The server auto-derives each file's ratio from its dimensions.

Examples

Creating an event via JSON

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationName": "com.example.test",
    "name": "Spring Event",
    "type": "CUSTOM",
    "startTimestamp": "2027-01-01 00:00:00",
    "endTimestamp": "2027-01-02 00:00:00",
    "allowedPartners": "APTOIDE-GAMES,APTOIDE-VANILLA",
    "locales": {
      "en_GB": {
        "description": "Short description",
        "longDescription": "Long description"
      }
    }
  }'

Creating an event with locale files via multipart/form-data

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "applicationName=com.example.test" \
  -F "name=Spring Event" \
  -F "type=CUSTOM" \
  -F "startTimestamp=2027-01-01 00:00:00" \
  -F "endTimestamp=2027-01-02 00:00:00" \
  -F "allowedPartners=APTOIDE-GAMES" \
  -F "locales[en_GB][description]=Short description" \
  -F "locales[en_GB][longDescription]=Long description" \
  -F "locales[en_GB][files][0]=@/path/to/asset-1.webp" \
  -F "locales[en_GB][files][1]=@/path/to/asset-2.webp"

Response

Success

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

Example Response

"538aaa1b-c3a2-40a5-97dd-6bf20645482e"