API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Create user

This method allows you to create a new user account in MyPreferences. It supports specifying user details such as username, email address, source group, user group, and other details required for onboarding.

The API creates a new user if one does not already exist. If a matching user is found and is inactive, the user will be reactivated. In both cases, the same response is returned.

Header Parameters

Authorizationstring

Authorization token

Content-Typestring

Media type indicating that the content is in JSON format.

Path Parameters

clientIdstring

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

Body Parameters

Phonestring

The user's contact phone number.

Descriptionstring

An optional text field for storing additional information or notes about the user.

UserNamestring

The unique login identifier for the user.

FirstNamestring

The user's given name.

LastNamestring

The user's family or surname.

Emailstring

The user's email address.

UserGroupsarray

Show child attributes

SourceGroupIDstring

The ID of the Source Group associated with the user.

DefaultLandingPagestring

The default page the user is directed to upon login. Options include Dashboard, ProfileSearch, and DataExport.

DefaultLandingPageTypeNbrnumber

A numeric code representing the type or category of the landing page.

IsSSOboolean

Indicates whether the new user is an SSO user. If set to true, user registration email will not be sent.

This property is only used during user creation. It does not reflect the SSO status of an existing user and will not modify any existing user data.

IsActiveboolean

Indicates whether the user account is currently active (true) or deactivated (false).

Response

201
Object
Created

Response Attributes

UserIdnumber

Unique identifier assigned to each user.

SubmittedTimestring

Date and time the request was submitted.

400
Object
The request was invalid and cannot be processed. This error may occur as a result of a malformed or syntactically incorrect request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect.
403
Object
API user does not have appropriate permissions to access the requested resource.
409
Object
The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?