User Registration

Estimated reading: 2 minutes

POST: /api/v{version}/User

Version: 1

Request Body:

				
					{
  "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "userName": "string",
  "displayName": "string",
  "email": "string",
  "password": "string",
  "role": 1,
  "image": "string",
  "cultureInfo": "string",
  "tagIds": [
    0
  ],
  "firmId": "string",
  "userIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Responses:

				
					200 SUCCESS
{
  "success": true,
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

				
					400 BAD REQUEST
{
  "message": "string",
  "exceptionType": 1,
  "version": "string"
}

If the user registration is successful, the user Id of the created user is returned.
Role types can be:
○ Manager = 1,
○ User = 2,
○ Group User = 3,
○ Integration User = 4,
○ Report User = 5
If a report is requested to be sent to the users’ e-mails, the e-mail information must be filled while creating the user.
Password field should be sent unencrypted.
The firmId field can be used to add the user’s unique Id in the client system. By using this firmId, data can be sent in data integrations.
The userIds field is only for role = 3 ie group users. The activities of the users whose IDs are given here are reflected to this user. This is the setup that should be used for group setups.
If the user registration is successful, the user Id of the created user is returned.
● Role types can be:
○ Manager = 1,
○ User = 2,
○ Group User = 3,
○ Integration User = 4,
○ Report User = 5
● If a report is requested to be sent to the users’ e-mails, the e-mail information must be filled while creating the user.
● Password field should be sent unencrypted.
● The firmId field can be used to add the user’s unique Id in the client system. By using this firmId, data can be sent in data integrations.
● The userIds field is only for role = 3 ie group users. The activities of the users whose IDs are given here are reflected to this user. This is the setup that should be used for group setups.
● tagIds contains the Ids that the user wants to have.
● CultureInfo:
○ en-TR
○ en-US
It can take one of its values.

User Registration

CONTENTS

How do I disable or delete a created competition?

How can I see the ranking of competing users?

Can I manually distribute prizes to competitors?

How do I edit a competition I created?

How can I create a new competition?

Competitions

How do I disable or delete a created mission?

How can I see the mission achievement ranking?

How can I see who has completed missions?

How can I edit a mission I created?

How can I create a new missions?

Missions