POST api/v1/Users

Create a new user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.

Collection of string

None.

suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

boolean

None.

APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

string

None.

APIToken

This is the user's session token generated when you authenticate the user

string

None.

Body Parameters

Create info

NewUser
NameDescriptionTypeAdditional information
loginName

User login name. Generally an email address

string

None.

firstName

User first name

string

None.

lastName

User last name

string

None.

password

User password. Must match company RegEx

string

None.

Request Formats

application/json, text/json

Sample:
{
  "loginName": "sample string 1",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "password": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

User
NameDescriptionTypeAdditional information
UserID

User's ID

globally unique identifier

None.

FirstName

User's first name

string

None.

LastName

User's last name

string

None.

ImageURL

URL to access user's image

string

None.

loginName

User's login name

string

None.

ImageSettings

Cropping settings for user's image

string

None.

IsDeleted

Has this user been deleted?

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": "0349dfea-34f6-47dd-ae4e-8a446513c77c",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "ImageURL": "sample string 4",
  "loginName": "sample string 5",
  "ImageSettings": "sample string 6",
  "IsDeleted": true
}