Create User

post https://api.paradox.ai/api/v1/public/users

Create a new user

Results

Here is a list of fields that can be provided for the user object

Key	Description
name	Full name (first and last) of the user
phone_number	Phone number of the user
email	Email address of the user

The result will have the following keys:

Key	Description
full_name	full name of the user
OID	id of the user
company_id	the company id of the user
phone_number	phone number of the user
user_email	email address of the user
formatted_number	recruiter number phone of the user
language_preference	Language code preference of the user
campus_permission_view	List of school area that user has view permission
campus_permission_approve	List of school area that user has approve permission
campus_entitlements	List of entitlements

Body Params

phone_number

string

required

Phone number of the user

name

string

required

Full name of the user

string

required

Email address of the user

role

int32

The role id of the user

user_type

int32

The user type id of user (Full: 0, Basic: 1)

prod_access_levels

array of int32s

The list of id of Product Access (Candidate Experience Manager: 1 and/or Student Experience Manager: 2). Example: [1,2]

prod_access_levels

timezone

string

The timezone string that references at List of tz database time zones

language_preference

string

Defaults to en

Language code preference

campus_permissions

array of objects

List of school area id and access type to add campus permission

campus_permissions

campus_entitlements

array of strings

List of entitlements with the value and assign campus permissions(if not use campus_permissions param)

campus_entitlements

employee_id

string

The user’s external employee id. If included, this cannot be blank, nor can it match any other employee-id for a user in this company.

job_title

string

The job’s title

location_ids

array of strings

An array of location OIDs which can be grabbed from Get Locations

location_ids

country_code

string

The user's country code, which followed by ISO 3166-2

area_ids

array of strings

An array of external area ID of area which be configured in UI

area_ids

location_codes

array of strings

An array of location external codes

location_codes

external_role_id

string

Custom user role id

Headers

Authorization

string

required

Defaults to Bearer <oauth_token>

Responses

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.paradox.ai/api/v1/public/users \
3
     --header 'Authorization: Bearer <oauth_token>' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "language_preference": "en"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Results

200200

400400