v1
latestOpenAPI 3.0.12026-07-24283883639.5 KBAwards
Update a Specific User Award
This endpoint updates the supplied fields for a specific award. <h3>Required Scope</h3>awards:write
patch/api/v2/awards/{id}
Path parameters
idstring required
The ID of the award to update.
Request body
Example request
{
"data": {
"type": "awards",
"id": "y7Aoy",
"attributes": {
"title": "Top Performer",
"awarded-at": "2015-04-01T06:00:00",
"image-url": "~/user-content/useroutcomeimage-8196-ef6c7e7b-215f-4bed-8dc0-94606049bb5c.jpg",
"url": "https://www.example.com/award/242354",
"issued-by": "Degreed"
}
}
}Response
Success
Example response
{
"data": {
"type": "awards",
"id": "y7Aoy",
"attributes": {
"title": "the best",
"image-url": "~/user-content/useroutcomeimage-8196-ef6c7e7b-215f-4bed-8dc0-94606049bb5c.jpg",
"url": "https://www.example.com/award/242354",
"issued-by": "Degreed"
},
"links": {
"self": "string"
},
"relationships": [
{
"user": {
"data": {
"id": "z1wbq9",
"type": "users"
}
}
}
]
}
}