Unibo
Backoffice

Opt a player in to a campaign

Opts a player in to an API opt-in campaign.

Recurring series — set match_recurring to true to opt the player in to every open
(scheduled or active) campaign of the series the given campaign belongs to, so one opt-in
button keeps working for the whole series:

  • The same campaigns are matched whichever campaign of the series is supplied — first,
    any in between, or last.
  • Every campaign of the series except drafts is matched, and each is handled exactly as
    if it had been opted in explicitly with match_recurring set to false: open ones take
    the opt-in, ended ones answer Campaign is not active..
  • A supplied campaign that has already ended still opts the player in to the series'
    open campaigns.
  • A campaign that is not part of a series is opted in on its own.
  • Safe to call repeatedly: nothing is opted in twice, and a campaign of the series that
    has opened since is opted in too.

With match_recurring the response lists each matched campaign under results, in
start order. The top-level detail is Success. when at least one campaign accepted
the opt-in; otherwise it is the first listed open campaign's answer (the first listed
campaign's when none is open), with its status code.

POST /api/v1/campaigns/opt_in_player
OAuth 2.0

Query parameters

· 1
tenant_name string required

Body

· OptInPlayerRequest
required application/json
request_id string required
campaign_id string required
player_id string required
match_recurring boolean · default: true

Opt in to every open (scheduled or active) campaign of the campaign's recurring series

Responses