POST /api/push/branding

Change a push group's name and brand.

Only the fields sent change: an empty field keeps its saved value. Nothing is sent to the phones and the call is not billed. Later notifications use the new brand; notifications already delivered do not change.

Body

Example

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"
  }
}'

Response

targeted is how many copies of the group changed. A pushGroupId that was never started answers targeted: 0 with the id in unknown.

1
2
3
4
5
6
7

{
  "ok": true,
  "targeted": 42,
  "unknown": [],
  "groupId": "pg-7hk3mzq2wd9x",
  "pushGroupId": "acme-orders"
}