メインコンテンツまでスキップ

イベントを編集する

既存のイベントは、Aptoide Connect デベロッパーコンソールを通じて、またはこの API エンドポイントを介してプログラムから更新できます。

エンドポイント​

メソッドURL
PATCHhttps://ws.catappult.io/api/events/{uid}

認証​

この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります（生成方法はこちらを確認してください）。

⚠️
必要なアカウントタイプ

イベントは、Developer タイプのアカウントによってのみ作成、編集、または削除できます。

ヘッダー​

ヘッダー型必須説明
Api-Keystring必須API リクエストの認証に使用されます。値は Aptoide Connect の API キーです。

パスパラメータ​

パラメータ型説明
uidstringイベントの一意の識別子（UUID）（例: 56fd535b-b071-402c-a4fa-29807eb050c9）。

ボディパラメータ​

すべてのボディパラメータは任意です。リクエストに含めたフィールドのみが更新されます。このエンドポイントは application/json または multipart/form-data のいずれかを受け付けます。

パラメータ型説明
namestringイベントの表示名を更新します。
startTimestampstring新しいイベントの開始日時。形式: YYYY-MM-DD HH:mm:ss。
endTimestampstring新しいイベントの終了日時。形式: YYYY-MM-DD HH:mm:ss。
allowedPartnersstringパートナー識別子のカンマ区切りリスト（例: APTOIDE-GAMES,APTOIDE-VANILLA）。有効な値については、利用可能なパートナーの一覧を参照してください。
locales[<localeName>][description]string指定したロケール（例: en_GB）の短い説明。
locales[<localeName>][longDescription]string指定したロケールの長い説明。
locales[<localeName>][files][<index>]file指定したロケールのアセットファイル。multipart/form-data として送信します。複数のファイルをアップロードするには、インデックス付きのキー（[0]、[1]、…）を使用します。サーバーは各ファイルの寸法から ratio を自動的に導出します。
locales[<localeName>][filesIds]string保持する既存のファイル ID のカンマ区切りリスト（例: 863,953）。リストに記載されていない既存のファイルはすべて削除されます。一部のファイルを保持しつつ新しいファイルを追加するには、files[<index>] と組み合わせて使用します。
⚠️
注記

ロケールを更新すると、そのロケールのエントリ全体が置き換えられるため、含めなかったフィールド（アップロードされた files を含む）はすべてクリアされます。以前にアップロードしたファイルを保持するには、その ID を filesIds に記載してください。

ファイルのアップロードには multipart/form-data が必要です。JSON では送信できません。

例​

JSON によるテキストフィールドの更新

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Event Name",
    "startTimestamp": "2026-02-04 00:30:00",
    "endTimestamp": "2026-04-30 00:00:00",
    "allowedPartners": "APTOIDE-GAMES,APTOIDE-VANILLA",
    "locales": {
      "en_GB": {
        "description": "Test",
        "longDescription": "Test"
      }
    }
  }'

multipart/form-data によるロケールファイルのアップロード

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "locales[en_GB][description]=Test" \
  -F "locales[en_GB][longDescription]=Test" \
  -F "locales[en_GB][files][0]=@/path/to/asset-1.webp" \
  -F "locales[en_GB][files][1]=@/path/to/asset-2.webp"

既存のファイルを保持しつつ新しいファイルを追加する

curl -X PATCH "https://ws.catappult.io/api/events/56fd535b-b071-402c-a4fa-29807eb050c9" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "locales[en_GB][description]=Test" \
  -F "locales[en_GB][longDescription]=Test" \
  -F "locales[en_GB][filesIds]=863,953" \
  -F "locales[en_GB][files][0]=@/path/to/new-asset.webp"

レスポンス​

成功​

API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、イベントが更新されました。

レスポンス例​

"Event updated."