GuidesAPI Reference
Log In
API Reference
  1. Awards

Update an existing award.

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

Partially updates an award. Only provided fields are changed.
Can update name, description, conditions, budget, amount, message,
visibility, state, and 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…
Path Params
string
required

Award ID.

Body Params

Partial update. Only provided fields are changed; omitted fields are left as-is.

string

Name for the award.

string | null

Optional notes describing the award's purpose.

string
enum

How the giver's eligibility conditions are combined.

Allowed:
conditions
array of objects
length ≥ 1

Replacement set of giver's eligibility rules.

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 | null

Point budget granted to the award each period_type. Null clears the budget (unlimited).

string
enum

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

Allowed:
integer | null

Default point amount granted when the award is given. May be null 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 | null

Default recognition message used when the award is given.

boolean

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

string
enum

Toggle the award on or off. Inactive awards cannot be given.

Allowed:
string
enum

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 | null

Replacement award icon image. Send null to remove the icon. 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 | null

Replacement approval chain. Send null or an empty array to remove the approval requirement.

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