Invite, edit or reset a user
manage_userInvite a new user (emails them a login unless calls-only), edit a user's profile — name, email, phone, role, teams, call device, notifications, caller ID, cooldown, accept time, CRM user links (hubspot_id, fub_id, …; find the ids with get_crm_options kind users) — or reset their password (emails a new one). Read current values with get_users first; confirm invites and resets with the user.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ext | No | Phone extension. | |
| role | No | admin, manager or agent. Not for the owner or yourself: those roles cannot be changed here. | |
| No | Login email. Giving a calls-only user an email gives them a login and emails them a password. | ||
| fname | No | First name. | |
| lname | No | Last name. | |
| action | Yes | invite: add a user (fname and phone_number required; email too unless allow_login is false). update: change the given fields of user_id. reset_password: email user_id a new random password they must change at login. | |
| fub_id | No | The Follow Up Boss user this user is (an id from get_crm_options kind users, platform followupboss), or null to unlink. Only when the account has a Follow Up Boss integration. | |
| cinc_id | No | The CINC user this user is (an id from get_crm_options kind users, platform cinc), or null to unlink. Only when the account has a CINC integration; update only. | |
| keap_id | No | The Keap user this user is (an id from get_crm_options kind users, platform keap), or null to unlink. Only when the account has a Keap integration; update only. | |
| user_id | No | The user to update or reset (ids from get_users). | |
| lofty_id | No | The Lofty user this user is (an id from get_crm_options kind users, platform lofty), or null to unlink. Only when the account has a Lofty integration; update only. | |
| send_sms | No | SMS notifications (update only). | |
| send_web | No | Browser notifications (update only). | |
| team_ids | No | The teams they belong to (ids from get_settings); replaces their current teams. Must not be empty. | |
| custom_id | No | Optional custom id for integrations. | |
| aircall_id | No | The Aircall user this user is (an id from get_crm_options kind users, platform aircall), or null to unlink. Only when the account has a Aircall integration; update only. | |
| brivity_id | No | The Brivity user this user is (an id from get_crm_options kind users, platform brivity), or null to unlink. Only when the account has a Brivity integration; update only. | |
| hubspot_id | No | The HubSpot user this user is (an id from get_crm_options kind users, platform hubspot), or null to unlink. Only when the account has a HubSpot integration. | |
| allow_login | No | Agents only. false on invite makes a calls-only agent with no login (no email sent). true gives a calls-only agent a login. A login cannot be removed. | |
| call_device | No | Where calls ring: phone (their phone_number), desktop (desktop/web app) or mobile (iOS/Android app). The apps need a login. | |
| callerid_id | No | Update only: the caller ID leads see when this user calls them (an id from the account's verified caller IDs), or null for their own number. | |
| send_emails | No | Email notifications. | |
| phone_number | No | The phone their calls ring, in E.164 (e.g. +13105551212). | |
| pipedrive_id | No | The Pipedrive user this user is (an id from get_crm_options kind users, platform pipedrive), or null to unlink. Only when the account has a Pipedrive integration; update only. | |
| wiseagent_id | No | The Wise Agent user this user is (an id from get_crm_options kind users, platform wiseagent), or null to unlink. Only when the account has a Wise Agent integration; update only. | |
| salesforce_id | No | The Salesforce user this user is (an id from get_crm_options kind users, platform salesforce), or null to unlink. Only when the account has a Salesforce integration; update only. | |
| gohighlevel_id | No | The GoHighLevel user this user is (an id from get_crm_options kind users, platform gohighlevel), or null to unlink. Only when the account has a GoHighLevel integration; update only. | |
| cooldown_seconds | No | Break after a call, 0-3600 seconds (with cooldown_override). | |
| activecampaign_id | No | The ActiveCampaign user this user is (an id from get_crm_options kind users, platform activecampaign), or null to unlink. Only when the account has a ActiveCampaign integration; update only. | |
| cooldown_override | No | Update only: true to use cooldown_seconds / cooldown_missed_seconds for this user, false to follow each team's cooldown. | |
| whispertext_loops | No | Accept time to press 1: 3 = 10s, 5 = 15s, 10 = 30s, 15 = 45s, 20 = 60s, 30 = 90s, 40 = 2 min (with accept_time_override). | |
| outbound_number_id | No | Update only: the dispatch number that rings this user: -1 random dispatch number, 0 the lead's number, or a caller ID id; null for the team default. | |
| accept_time_override | No | Update only: true to use whispertext_loops for this user, false to follow the account's accept time. | |
| cooldown_missed_seconds | No | Break after a missed call, 0-3600 seconds (with cooldown_override). | |
| is_admin_billing_access | No | Owner only, admins only: whether this admin can manage billing. Defaults to on when the owner invites an admin. |