GuidesAPI Reference
Log In
API Reference
  1. Awards

Create a new award.

post
https://bonus.ly/api/public/awards

Creates a new manual award for the user's company.
Sets up the award, eligibility conditions, and optional approval process.

Requires the awards:administer scope and awards admin permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name for the award.

string

Optional notes describing the award's purpose.

string
enum
required

How the giver's eligibility conditions are combined. and requires all to match; or requires any.

Allowed:
conditions
array of objects
required
length ≥ 1

Giver's eligibility rules. At least one is required.

conditions*

A single attribute equality rule used by conditions. Matches when a user's attr equals value.

string
required

User attribute being matched (e.g. department, country).

string
required

Expected value for the user attribute.

integer

Point budget granted to the award each period_type. Omit for unlimited.

string
enum
required

Cadence at which budget_per_period resets. Use lifetime for a single, non-recurring budget.

Allowed:
integer

Default point amount granted when the award is given. Omit only when amount_editable is true; the giver then supplies the amount.

boolean

When true, the giver can override the default amount at giving time.

string

Display name shown as the award's giver in the recognition feed.

string

Default recognition message used when the award is given.

boolean

When true, the giver can override the default message at giving time.

string
enum
required

Whether recognition from this award is visible to the whole company, only to the recipient, or only to the recipient's immediate team.

Allowed:
boolean

When true, the giver can override visibility at giving time.

boolean

When true, the giver is hidden from recipients in the recognition feed.

string

Award icon image source. Accepts one of:

  • A staged upload file_url from POST /uploads
  • An external HTTPS URL pointing to an image
  • An RFC 2397 data URI (data:image/jpeg;base64,...)

Allowed MIME types: image/jpeg, image/png, image/gif, image/webp.
Maximum file size: 20MB.

approval_process_levels
array of objects

Ordered list of approval levels required before a give-attempt is finalized.
Omit or send an empty array for an award that requires no approval.

approval_process_levels
Responses

Updated 2 months ago

Language
Credentials
Bearer
OAuth2 access token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago