User Activation

This endpoint can be used to activate / unblock a new user using the activation-code received during creation.

Reference

POST /user/activate/

Activate the user

POST /user/activate/generate/

(re)-generate an activationcode and revoke all previously generated activationcodes. A maximum of 5 requests per hour is allowed for this endpoint.

Fields activate user

field type constraints Req
userId int Yes
activationtoken string Yes

Fields activate/generate object

field type constraints Req W U
userId int Yes Yes No
activationtoken string A unique token for use with the User Activation No No No
validUntil datetime The expiration-date of this token No No No

Example activating a user

Request

POST /user/activate/ HTTP/2
{
 "userId": 12311,
 "activationtoken": "dk39r89ge9frt89375837g987uf8yr8"
}

Response

{
 "result": false,
 "errors": [
   "invalid activationtoken or token expired"
 ]
}

or

{
 "result": true,
 "errors": [],
 "data": []
}

Example generating activationcode

Request

POST /user/activate/generate/ HTTP/2
{
  "userId": 12311
}

Response

{
  "result": true,
  "errors": [],
  "data": {
    "userId": 12311,
    "activationtoken": "7e3dff2f25b589e73d7f99fefb154e84800ca9d89a4e387f9f3b7c1f4254695c",
    "validUntil": "2025-07-01 13:09:45"
  }
}

or

{
  "result": false,
  "errors": [
    "maximum number of requests has exceeded. please try again later..."
  ]
}