Sign in

v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Awards

Create a New User Award

This endpoint creates a new award for the specified user. <h3>Required Scope</h3>awards:write

post/api/v2/awards

Request body

Example request

{
  "data": {
    "type": "awards",
    "attributes": {
      "user-id": "info@example.com",
      "user-identifier-type": "Email",
      "title": "Top Performer",
      "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": {
      "user-identifier-type": "Email",
      "user-id": "user@example.com",
      "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"
    },
    "links": {
      "self": "string"
    }
  }
}