Step 3: Create User

POST {{apiPath}}/environments/{{envID}}/users

The POST /environments/{{envID}}/users operation creates the new user resource in the specified environment. Associate the user with the population you just created.

PropertyTypeRequired?
accountIdStringOptional
address.streetAddressStringOptional
address.countryCodeStringOptional
address.localityStringOptional
address.regionStringOptional
address.postalCodeStringOptional
address.zipCodeStringOptional
emailStringOptional
localeArray [String]Optional
mobilePhoneStringOptional
name.givenStringOptional
name.familyStringOptional
name.middleStringOptional
name.honorificPrefixStringOptional
name.honorificSuffixStringOptional
name.formattedStringOptional
nicknameStringOptional
photo.hrefStringOptional
population.idStringRequired
preferredLanguageStringOptional
primaryPhoneStringOptional
timeZoneStringOptional
titleStringOptional
typeStringOptional
usernameStringRequired

See the User operations data model for full property descriptions.

Request Body

{"email"=>"marysample@example.com", "name"=>{"given"=>"Mary", "family"=>"Sample"}, "population"=>{"id"=>"{{popID}}"}, "username"=>"marysample", "department"=>"engineering", "locales"=>["Sydney", "London"]}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring