try out ↗

← API Index


/api/admin/pushactiongroup

Queue one push notification for every current member of an action group (Aktionsgruppe). Admin only. Returns immediately: the pushes are queued as a message series and delivered in the background (throttled), through the tenant's regular push delivery or its external push hook. Follow the result via stats/mailcampaigns1 with the returned serieref, or cancel the rest via message/series/cancel. Use dryrun=1 first to see how many members would be addressed.

Parameters

Name Description Type
agid id of the action group (see /api/system/actiongroups) int
title notification title (required unless dryrun, max 200 characters) string
message notification text (required unless dryrun, max 1000 characters) string
imageUrl optional image to show with the notification string
linkUrl optional link to open when the notification is tapped (tracked for click statistics) string
dryrun if true, only count the members and queue nothing (result 'dryrun') bool
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
401 not_authorized Caller is not an admin
400 parameter_error agid missing or unknown, or title/message missing or too long (detail in error_field:error_reason)

Response Types

Type Version Description
PushActionGroupResult 1 Result of queueing a push message to all members of an action group

OpenAPI

See pushactiongroup.yaml

Referenced in skills