HomeTutorialsAPI ReferenceStatus
API Reference

Create User

post
https://{APP_DOMAIN}/api/3.2/users

Creates a new platform user account. A temporary password is generated and emailed to the user if active. The user will be required to change their password on first login.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body Params

string
required

The user's first name.

string
required

The user's last name.

string
required

The user's email address

boolean
required

Whether the user is currently in active status.

boolean
required

Whether the user is an internal employee.

boolean
required

Whether the user must change their password on next login. A temporary password is generated and emailed by OptiPub; clients never set the password directly.

date

The hire date of the user. Required if is_internal is true.

date

The end date for the user. Required to be after hire date.

string

The user's Slack username.

string

The user's home phone number.

string

The user's mobile phone number.

string

The user's office phone number.

groups
array of integers

Array of group ids to associate with the user.

groups
socials
object

Social media links

Response

Updated 5 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 days ago