GuidesAPI Reference
Log In
API Reference
  1. Awards
  2. Awards

Give an award to one or more recipients.

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

Initiates an award give on behalf of the authenticated user.
The user must satisfy the award's eligibility conditions.

If the award has no approval process, the give is auto-approved
and a bonus is created immediately. Otherwise, an approval
request is created and approvers are notified.

Requires the awards:write scope.

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

Award ID.

Body Params
string
required

Full recognition reason string including amount prefix, @mention tokens,
and message text. Example: "+100 @JaneDoe Great teamwork on the project!"
Recipients are resolved automatically from @mentions in the message.

string
enum

Visibility of the resulting recognition. Only honored when the award allows privacy changes (visibility_editable). Falls back to the award's default visibility when omitted.

Allowed:
boolean

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

Responses

Updated about 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 about 2 months ago