Users & Teams
Manage the people on your team. Invite new members, deactivate accounts without losing data, and control access to CRM modules.
The User Object
Section titled “The User Object”| Field | Type | Description |
|---|---|---|
id | uuid | |
account_id | uuid | |
email | string | |
name | string | |
role | string | |
bcc_token | string | |
must_change_password | bool | |
deactivated_at | datetime? | |
created_at | datetime | |
updated_at | datetime |
Change the current user’s password
Section titled “Change the current user’s password”Endpoint: users-change-password
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | Yes | |
new_password | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/users-change-password \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"current_password": "...", "new_password": "..."}'Request a password reset email
Section titled “Request a password reset email”Endpoint: users-forgot-password
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/users-forgot-password \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"email": "..."}'Invite a new user to the account
Section titled “Invite a new user to the account”Endpoint: users-invite
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | |
name | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/users-invite \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"email": "...", "name": "..."}'List users in the account
Section titled “List users in the account”Endpoint: users-list
| Field | Type | Required | Description |
|---|---|---|---|
search | string | No | |
limit | int | No | |
offset | int | No |
curl -X POST https://api.driftwoodapp.com/api/users-list \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'Reset password using a reset token
Section titled “Reset password using a reset token”Endpoint: users-reset-password
| Field | Type | Required | Description |
|---|---|---|---|
token | string | Yes | |
new_password | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/users-reset-password \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"token": "...", "new_password": "..."}'Activate or deactivate a user
Section titled “Activate or deactivate a user”Endpoint: users-set-active
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
active | bool | No |
curl -X POST https://api.driftwoodapp.com/api/users-set-active \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"user_id": "..."}'