User API

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.
Share this Doc

User Registration

Or copy link

CONTENTS

Motivacraft Mobile App Settings

https://vimeo.com/1069966982/7d406797c1?share=copy Learn more about settings in ...

Motivacraft Mobile App Reward Market

https://vimeo.com/1069955830/e5e4a559a9?share=copy Learn more about reward marke...

Motivacraft Mobile App My Profile

https://vimeo.com/1069946863/63c2bce8b9?share=copy Learn more about your profile...

Motivacraft Mobile App Your Story

https://vimeo.com/1069877756/3f9c985da3?share=copy Learn more about your story i...

Motivacraft Mobile App Manual Data Entry

https://vimeo.com/1069929212/4ec1056165?share=copy How to enter data manually us...

Motivacraft Mobile App Trainings

https://vimeo.com/1069888868/0bb082552f?share=copy Learn more about Motivacraft ...

How can i see missions and competitions in mobile app?

https://vimeo.com/1069877756/3f9c985da3?share=copy How to get details for the mi...

Motivacraft Mobile App Home Screen

https://vimeo.com/1069866069/6d878ffd57?share=copyWhat awaits you in the Motivac...

How competitions based on test results work?

This provides clarity on how our platform conducts competitions based on test an...

How can I use MotivacraftTV?

We will show you how to use MotivacraftTV step by step.We will show you how to u...

MotivacraftTV

Articles

Chat Icon Close Icon