POST /api/push/branding
プッシュグループの名前とブランドを変更します。
送ったフィールドだけが変わり、空のフィールドは保存済みの値のままです。スマートフォンには何も送られず、この呼び出しは請求されません。以降の通知には新しいブランドが使われ、配信済みの通知は変わりません。
本文
| フィールド | 型 | 説明 |
|---|---|---|
pushGroupId | string | 必須。変更するグループ。 |
brand | object | 必須。startと同じくlogo、name、description。 |
group | string | アプリでユーザーに表示される新しいグループ名。 |
例
1 2 3 4 5 6 7 8 9 10
curl -X POST https://api.webliveactivity.com/api/push/branding \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "pushGroupId": "acme-orders", "group": "Acme Deliveries", "brand": { "logo": "https://acme.example/logo-v2.webp" } }'
レスポンス
targetedは、変更されたグループのコピーの数です。開始されていないpushGroupIdの場合はtargeted: 0を返し、そのIDはunknownに含まれます。
1 2 3 4 5 6 7
{ "ok": true, "targeted": 42, "unknown": [], "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders" }
