POST /api/end
Quita una o varias actividades del celular.
Un fin quita la tarjeta de inmediato, sin sonido. Para dejar un diseño final en pantalla, envíalo como actualización y finaliza la actividad después. Los destinos funcionan igual que en update.
El registro se conserva, así que una actualización con restart: true puede traer la tarjeta de vuelta. El límite del plan gratis nunca bloquea un fin.
Por id de actividad
1 2 3 4 5 6 7
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityId": "act-8f2cqa4mx7rd", "widgetContainerId": "acme-orders" }'
Por varios ids de actividad
1 2 3 4 5 6 7 8 9 10
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityIds": [ "act-8f2cqa4mx7rd", "act-9k4d2bwh6tne" ], "widgetContainerId": "acme-orders" }'
Por grupo
Finaliza todas las actividades del grupo con una sola llamada.
1 2 3 4 5 6 7
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "group": "order-tracker", "widgetContainerId": "acme-orders" }'
Guarda un estado final
finalState se combina con el estado guardado, como una actualización. La tarjeta no lo muestra. Un reinicio posterior parte de él.
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityId": "act-8f2cqa4mx7rd", "widgetContainerId": "acme-orders", "finalState": { "primaryText": "Delivered", "progress": 1, "isComplete": true } }'
Respuesta
Devuelve { ok, targeted, unknown }, igual que update.
1 2 3 4 5
{ "ok": true, "targeted": 1, "unknown": [] }
