Skip to main content
PATCH
Update award record

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
user
integer
required
award_record
integer
required

Query Parameters

include
enum<string>
Available options:
attachments,
author,
author.*,
award,
award.image,
comments,
comments.*,
document

Body

application/json
user_id
integer
required

The ID of the user receiving the award.

award_id
integer
required

The ID of the award being given.

document_id
integer | null

The ID of the document associated with this award record.

author_id
integer

The ID of the user who created this award record.

text
string | null

Additional notes or information about this award. Supports HTML.

Maximum string length: 65535

Response

OK

data
AwardRecordResource · object