Invite or Add Users
New users in DealCloud can either be created, invited, or "shadow"-added. If a user email already exists in the DealCloud Universe, attempting to create a new user with the same email will result in an error. Hence, these "existing" users need to be invited or shadow-added. This page covers inviting and shadow-adding users to a DealCloud site.
Endpoints
Invite User to a Site
Invites an existing user from the DealCloud Universe to the site. Sends an email invitation to the user which they must accept in order to join the site. Users can be invited temporarily or permanently.
POST {{host}}/api/rest/v1/management/user/inviteShadow-Add User to a Site
Shadow adds an existing user from the DealCloud Universe to the site. No email invitation or user acceptance occurs. The user is quietly added to the site. Users can be added temporarily or permanently.
Note: only existing users with an email domain that matches the dedicated domain defined for the site are eligible to be added through this endpoint.
POST {{host}}/api/rest/v1/management/user/addexistinguserParams
| name | Parameter Type | Data Type | Example | Description |
|---|---|---|---|---|
| body | string | testuser@intapp.com | Email of user | |
| duration | body | int | 10 | If temporary user, set duration in # of days |
| groups | body | int[ ] | 12, 22, 192 | Group assignment |
| autoCreateOrLinkContact | body | integer | true | If set to true, links invited user to contact |
| mappedContactID | body | integer | 0 | Creates new contact if ommitted and autoCreateorLinkedContact is set to true |
Examples
POST {{host}}/api/rest/v1/management/user/invite
Authorization: Bearer {{token}}
Content-Type: application/json
{
"email": "testuser@intapp.com",
"duration": 5,
"groups": [
15
],
"autoCreateOrLinkContact": true,
"mappedContactId": 0
}