v2

latestOpenAPI 3.0.02026-08-04911995.6 KB

Rewards Actions

Grant a Reward

Grants a reward for a user. Note 1: currently only granting of credit rewards is supported. Note 2: this endpoint is only accessible with a secret API key.

post/users/{app_user_id}/rewards/grant

Path parameters

app_user_idstring required

The app user id of the user to grant a reward to.

Headers

x-api-keystring required

The secret API key.

Request body

keystring required

The key of the reward to grant

operation_idstring nullable

An optional operation id that ensures the same operation won't be performed again

Example request

{
  "key": "discounted-offering",
  "operation_id": "821fae4b5-0123-4567-9152-5297086a161c"
}

Response

The reward has been already available for the user and cannot be granted again.