Appearance
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 parameter | data type | description |
|---|---|---|
targetPath* | string | the path to the organization or tenant where the user record 'lives' |
body.email* | ||
body.metadata.lastName* | string | |
body.metadata.firstName* | string | |
body.displayName | string | |
body.active | active | the active status of the user |
body.metadata.middleName | string | |
body.metadata.hireDate | number | unix time representation of the hire date |
body.metadata.address | AddressType[] | the mailing address of the user |
body.metadata.userContactInformation | ContactInformationType[] | the contact information for the user |
body.metadata.emergencyContactInformation | EmergencyContactInformationType[] | 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