SPsponsorunited
User Management

Create new user

Creates a new user with the provided information.

post/api/user

Request

Request body

namestring required

User's full name

emailstring email required

User's email address

passwordstring password required

Password (min 8 chars, mixed case, letters, symbols)

roleinteger required

Role ID to assign to user

person_profile_job_role_idinteger

Job role ID from person profiles

job_titlestring

User's job title

linkedin_urlstring

LinkedIn profile URL

facebook_urlstring

Facebook profile URL

twitter_urlstring

Twitter/X profile URL

instagram_urlstring

Instagram profile URL

organizationsinteger[]

Organization IDs to associate

permissionsstring[]

Permission strings to assign

is_externalboolean

Whether user is external

force_new_passwordboolean

Force password change on first login

send_credentialsboolean

Send credentials email to user

templatestring

Email template to use for credentials

role_orientation_idinteger nullable

Id of a role orientation, as returned by GET /api/role-orientation (machine keys for reference: sell_side, buy_side, student, both). When omitted or null the user is assigned the default orientation (both).

Example request

{
  "role_orientation_id": 2
}

Response

User created successfully

idinteger
emailstring
currencystring
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time
last_active_atstring date-time
is_externalboolean
verifiedinteger
genuineinteger
hubspot_idinteger
hubspot_synced_onstring date-time
force_new_passwordinteger
credentials_sent_atstring date-time

Example response

{
  "role_orientation": {
    "id": 1,
    "name": "sell_side",
    "label": "Sell-Side"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.