Skip to content

Create User

To create a user post the user data to the endpoint below.

  • The email must be unused within the target, and the first and last names must be provided.
  • User are default assumed to be active when imported, so they will count towards your seat count.

Parameters

name * are required parameterdata typedescription
targetPath*stringthe path to the organization or tenant where the user record 'lives'
body.email*Email
body.metadata.lastName*string
body.metadata.firstName*string
body.displayNamestring
body.activeactivethe active status of the user
body.metadata.middleNamestring
body.metadata.hireDatenumberunix time representation of the hire date
body.metadata.addressAddressType[]the mailing address of the user
body.metadata.userContactInformationContactInformationType[]the contact information for the user
body.metadata.emergencyContactInformationEmergencyContactInformationType[]the users emergency contact information

Return Value

the active status indicator boolean for the user

Examples

bash
curl -X POST -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user/create -d "{ ...data... }"

ENDPOINTS

post/api/{targetPath}/user/create