Skip to main content
POST
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

key
string
required

Unique reference of the achievement as set when created.

Body

application/json
user
Upserted User · object
required

The user that completed the achievement.

Response

Successful operation

completionId
string
required

The unique ID of the completion.

Example:

"0040fe51-6bce-4b44-b0ad-bddc4e123534"

achievement
UserAchievementResponse · object
required
points
object
required

A map of points systems by key that were affected by this achievement completion.