Create an Achievement

Post an achievement for one or more employees. The achievement can highlight the completion of a professional development course, a wellness challenge or the launch of a new product by a team, etc. You can notify others of the achievement and award points to each participant (points are debited from the program’s master accounts).

Step 1

Obtain a system access token through our 1-step client_credentials OAuth 2.0 flow.

📘

For more information about authentication, see Authentication.

Step 2

Retrieve the participant's information, including username and userId, by using your access token to make a GET request to the /users endpoint. Repeat this for each remaining participant. You can search for an employee by first name, last name or email address.

{
    "id": 10726811,
    "firstName": "Adele",
    "lastName": "Olson",
    "username": "adele.olson",
    "emailAddress": "[email protected]",
    "dateCreated": "2016-02-19T14:22:11-05:00",
    "links": {
        "self": {
            "href": "https://example.uat.achievers.com/api/v5/users/1085141",
            "method": "GET",
            "rel": "self"
        }
    },
    "profileImageUrl": "https://example.uat.achievers.com/platform_content/system/user/icon_med.jpg",
    "isPersonalizedProfileImage": false
}

📘

For more information about the /users endpoint, see users.

Step 3

If you want to include a custom image as part of the achievement, make a POST request to the /uploads endpoint using your access token. The endpoint will return a fileUploadId, which can be referenced in a subsequent POST request to the /achievements endpoint (see below).

📘

For more information about the uploads endpoint, see uploads.

Step 4

Create the achievement by using your access token to make a POST request to the /achievements endpoint with the username(s) and, if applicable, the fileUploadId retrieved in the previous steps. You have the option of specifying a user as the creator of the achievement, who will be included as a participant. You also have the option of specifying a point amount to award to each participant. For programs that use purchase power parity (PPP) rates, you can use the adjustedForUserCountry parameter to indicate whether the specified point amount is relative to the program's base country or to each participant's country.

Note that if you are sending userIds for the user-identifying parameters, the useUserIds parameter must be set to true. If you are sending usernames, useUserIds is not required or must be set to false.

📘

For more information about the /achievements endpoint, see achievements.