try out ↗

← API Index


/api/client/applybonus

Apply for a bonus campaign. The customer opts into a campaign that requires explicit application.

Parameters

Name Description Type
bonus_id the bonus campaign id to apply for 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 security_error User is not authenticated
400 PARAMETER_ERROR Missing or invalid bonus_id parameter
403 not_eligible The customer's bonus group (customers.groupid) may not take part in this campaign (bonus.included_customertype / excluded_customertype)

Response Types

Type Version Description
BonusResult 1 Result of a bonus action (apply, claim or admin set)

OpenAPI

See applybonus.yaml

Referenced in skills