try out ↗

← API Index


/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

Name Description Type
agid id of the actiongroup to join/leave int
member 1 to join, 0 to leave int
cid target customer id, admin only int
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
403 not_authenticated No authenticated customer session
403 security_error Only admins may set/remove actiongroup membership for another customer
400 error Missing or invalid agid/member parameter

Response Types

Type Version Description
ActionGroupResult 1 Result of setting/removing actiongroup membership for a customer

OpenAPI

See actiongroup.yaml

Referenced in skills