Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Body

application/json

Reward approval payload.

Rewards to approve. Provide exactly one of reward_ids or filter. Only ACCRUED entries change; entries already APPROVED or PAID are left untouched.

reward_ids
string[]

Reward entry IDs to approve.

Minimum array length: 1
Example:
filter
object

Approve every ACCRUED entry this matches, in one call. Selects entries the same way the filters on list all rewards do. Give at least one field.

Example:

Response

Reward batch response.

The result of approving rewards or marking them paid.

object
enum<string>
required

Object type, reward_batch.

Available options:
reward_batch
Example:

"reward_batch"

status
enum<string>
required

The status the entries were moved to.

Available options:
APPROVED,
PAID
Example:

"PAID"

count
integer
required

Number of entries this call changed. Entries that were already in this status, or past it, are not counted.

Required range: x >= 0
Example:

1840