/api/client/actiongroup

Join or leave an Aktionsgruppe (action group) as the authenticated customer. Admins may act on behalf of another customer via the 'cid' parameter.

Parameters

(int) id of the actiongroup to join/leave
(int) 1 to join, 0 to leave
(int) target customer id, admin only
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) 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.

Error Responses

HTTP StatusError CodeDescription
403not_authenticatedNo authenticated customer session
403security_errorOnly admins may set/remove actiongroup membership for another customer
400errorMissing or invalid agid/member parameter

Response Types

ActionGroupResult

ActionGroupResult (v1) docs

Result of setting/removing actiongroup membership for a customer

Fields (3)
#FieldTypeDescription
0actionstringthe action that was performed
1resultstringthe exit/result code of the action
2actiongroupidsint[]resolved (confirmed + pending) actiongroup ids the target customer is currently a member of

Data (1 record)

actionresultactiongroupids
SetActionGroupMembershipnot_authenticated[]