HighLevel: Users schemas
8 HighLevel schemas with complete fields and constraints.
← Users operations · All schemas
Delete User — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | Message describing the result of the deletion request |
succeeded | boolean | Optional | Indicates whether the user deletion was queued successfully |
Filter Users by Email — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
companyId | string | Required within parent | Company ID to filter users |
deleted | boolean | Optional | Filter deleted users Default: false |
emails | string | Required within parent | Comma-separated list of email addresses to filter users |
limit | string | Optional | No of results to be limited before returning the result Default: 25 |
projection | string | Optional | Projection fields to return. Use "all" for all fields, or specify comma-separated field names. Default returns only id and email |
skip | string | Optional | No of results to be skipped before returning the result Default: 0 |
Get User — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Email address of the user |
extension | string | Optional | Phone extension of the user |
firstName | string | Optional | First name of the user |
id | string | Optional | Unique identifier of the user |
lastName | string | Optional | Last name of the user |
lcPhone | object | Optional | LC Phone Inbound Phone Numbers |
name | string | Optional | Full name of the user |
permissions | JSON | Optional | User permissions controlling access to various features |
permissions (allOf 1) | Model | All variants apply | Expand Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only |
phone | string | Optional | Phone number of the user |
platformLanguage | string | Optional | Platform language preference for the user Known values: en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no |
roles | JSON | Optional | Role and access configuration for the user |
roles (allOf 1) | Model | All variants apply | Expand Get User — response body — roles location Ids, restrict Sub Account, role, type |
scopes | string | Optional | List of OAuth scopes granted to this user Known values: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, pipelines.create, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.write, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, ai-studio.readonly, ai-studio.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly, locations.create, locations.delete, askai.write, copilot.readonly, locations.export.list, locations.features-limits.manage, locations.pause-resume, locations.agency-subaccounts.manage, locations.billing.manage, locations.details.manage, audit-logs.readonly, audit-logs.export |
Referenced models: Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only, Get User — response body — roles location Ids, restrict Sub Account, role, type
Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adwordsReportingEnabled | boolean | Optional | Whether AdWords reporting is enabled for this user Default: false |
affiliateManagerEnabled | boolean | Optional | Whether the affiliate manager is enabled for this user Default: true |
agentReportingEnabled | boolean | Optional | Whether agent reporting is enabled for this user Default: true |
appointmentsEnabled | boolean | Optional | Whether appointments are enabled for this user Default: true |
assignedDataOnly | boolean | Optional | Whether the user can only access data assigned to them Default: false |
attributionsReportingEnabled | boolean | Optional | Whether attributions reporting is enabled for this user Default: false |
bloggingEnabled | boolean | Optional | Whether blogging is enabled for this user Default: true |
botService | boolean | Optional | Whether the bot service is enabled for this user Default: false |
bulkRequestsEnabled | boolean | Optional | Whether bulk requests are enabled for this user Default: true |
campaignsEnabled | boolean | Optional | Whether campaigns are enabled for this user Default: true |
campaignsReadOnly | boolean | Optional | Whether campaigns are in read-only mode for this user Default: false |
cancelSubscriptionEnabled | boolean | Optional | Whether cancelling subscriptions is enabled for this user Default: true |
communitiesEnabled | boolean | Optional | Whether communities are enabled for this user Default: true |
contactsEnabled | boolean | Optional | Whether contacts are enabled for this user Default: true |
contentAiEnabled | boolean | Optional | Whether Content AI is enabled for this user Default: true |
conversationsEnabled | boolean | Optional | Whether conversations are enabled for this user Default: true |
dashboardStatsEnabled | boolean | Optional | Whether dashboard statistics are enabled for this user Default: true |
exportPaymentsEnabled | boolean | Optional | Whether exporting payments is enabled for this user Default: true |
facebookAdsReportingEnabled | boolean | Optional | Whether Facebook Ads reporting is enabled for this user Default: false |
funnelsEnabled | boolean | Optional | Whether funnels are enabled for this user Default: true |
invoiceEnabled | boolean | Optional | Whether invoices are enabled for this user Default: true |
leadValueEnabled | boolean | Optional | Whether lead value features are enabled for this user Default: true |
marketingEnabled | boolean | Optional | Whether marketing features are enabled for this user Default: true |
membershipEnabled | boolean | Optional | Whether membership features are enabled for this user Default: false |
onlineListingsEnabled | boolean | Optional | Whether online listings are enabled for this user Default: true |
opportunitiesEnabled | boolean | Optional | Whether opportunities are enabled for this user Default: true |
paymentsEnabled | boolean | Optional | Whether payments are enabled for this user Default: true |
phoneCallEnabled | boolean | Optional | Whether phone calls are enabled for this user Default: true |
recordPaymentEnabled | boolean | Optional | Whether recording payments is enabled for this user Default: true |
refundsEnabled | boolean | Optional | Whether refunds are enabled for this user Default: true |
reviewsEnabled | boolean | Optional | Whether reviews are enabled for this user Default: true |
settingsEnabled | boolean | Optional | Whether settings are enabled for this user Default: true |
socialPlanner | boolean | Optional | Whether the social planner is enabled for this user Default: true |
tagsEnabled | boolean | Optional | Whether tags are enabled for this user Default: true |
triggersEnabled | boolean | Optional | Whether triggers are enabled for this user Default: true |
websitesEnabled | boolean | Optional | Whether websites are enabled for this user Default: false |
workflowsEnabled | boolean | Optional | Whether workflows are enabled for this user Default: true |
workflowsReadOnly | boolean | Optional | Whether workflows are in read-only mode for this user Default: false |
Get User — response body — roles location Ids, restrict Sub Account, role, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
locationIds | array | Optional | List of location IDs the user has access to |
locationIds[] | string | Each item | |
restrictSubAccount | boolean | Optional | Whether the user is restricted to specific sub-accounts only |
role | string | Optional | User role within the account (admin or user) |
type | string | Optional | User account type (account for sub-account users, agency for agency-level users) |
Search Users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Optional | |
count (anyOf 1) | number | Alternative | Total number of users matching the search criteria |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
users | array | Optional | List of users matching the search criteria |
users[] | Model | Each item | Expand Search Users — response body — users item |
Referenced models: Search Users — response body — users item
Search Users — response body — users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Optional | Whether the user has been deleted |
email | string | Optional | Email address of the user |
extension | string | Optional | Phone extension of the user |
firstName | string | Optional | First name of the user |
id | string | Optional | Unique identifier of the user |
lastName | string | Optional | Last name of the user |
lcPhone | object | Optional | LC Phone Inbound Phone Numbers |
name | string | Optional | Full name of the user |
permissions | JSON | Optional | User permissions controlling access to various features |
permissions (allOf 1) | Model | All variants apply | Expand Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only |
phone | string | Optional | Phone number of the user |
platformLanguage | string | Optional | Platform language preference for the user Known values: en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no |
roles | JSON | Optional | Role and access configuration for the user |
roles (allOf 1) | Model | All variants apply | Expand Get User — response body — roles location Ids, restrict Sub Account, role, type |
scopes | string | Optional | List of OAuth scopes granted to this user Known values: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, pipelines.create, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.write, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, ai-studio.readonly, ai-studio.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly, locations.create, locations.delete, askai.write, copilot.readonly, locations.export.list, locations.features-limits.manage, locations.pause-resume, locations.agency-subaccounts.manage, locations.billing.manage, locations.details.manage, audit-logs.readonly, audit-logs.export |
Referenced models: Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only, Get User — response body — roles location Ids, restrict Sub Account, role, type
Update User — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
companyId | string | Optional | Company/Agency Id. Required for Agency Level access |
email | string | Optional | Email update is no longer supported due to security reasons. |
firstName | string | Optional | First name of the user |
lastName | string | Optional | Last name of the user |
locationIds | array | Optional | List of sub-account location IDs the user should have access to |
locationIds[] | string | Each item | |
password | string | Optional | New password for the user account. All passwords will be required to meet the following criteria: - Minimum 12 characters - At least one uppercase letter (A–Z) - At least one lowercase letter (a–z) - At least one number (0–9) - At least one special character (e.g., !, @, #, $) |
permissions | JSON | Optional | User permissions controlling access to various features |
permissions (allOf 1) | Model | All variants apply | Expand Get User — response body — permissions adwords Reporting Enabled, affiliate Manager Enabled, agent Reporting Enabled, appointments Enabled, assigned Data Only, attributions Reporting Enabled, blogging Enabled, bot Service, bulk Requests Enabled, campaigns Enabled, campaigns Read Only, cancel Subscription Enabled, communities Enabled, contacts Enabled, content Ai Enabled, conversations Enabled, dashboard Stats Enabled, export Payments Enabled, facebook Ads Reporting Enabled, funnels Enabled, invoice Enabled, lead Value Enabled, marketing Enabled, membership Enabled, online Listings Enabled, opportunities Enabled, payments Enabled, phone Call Enabled, record Payment Enabled, refunds Enabled, reviews Enabled, settings Enabled, social Planner, tags Enabled, triggers Enabled, websites Enabled, workflows Enabled, workflows Read Only |
phone | string | Optional | Phone number of the user in E.164 format |
platformLanguage | string | Optional | Platform language preference for the user One of: en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no |
profilePhoto | string | Optional | URL of the user profile photo |
role | string | Optional | User role within the account (admin or user) |
scopes | array | Optional | Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the scopes will be get disabled |
scopes[] | string | Each item | One of: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, pipelines.create, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.write, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, ai-studio.readonly, ai-studio.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly, locations.create, locations.delete, askai.write, copilot.readonly, locations.export.list, locations.features-limits.manage, locations.pause-resume, locations.agency-subaccounts.manage, locations.billing.manage, locations.details.manage, audit-logs.readonly, audit-logs.export |
scopesAssignedToOnly | array | Optional | Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled |
scopesAssignedToOnly[] | string | Each item | One of: campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, pipelines.create, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.write, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, ai-studio.readonly, ai-studio.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly, locations.create, locations.delete, askai.write, copilot.readonly, locations.export.list, locations.features-limits.manage, locations.pause-resume, locations.agency-subaccounts.manage, locations.billing.manage, locations.details.manage, audit-logs.readonly, audit-logs.export |
twilioPhone | object | Optional | Per-location inbound Twilio number in E.164 format, keyed by location id (Call and Voicemail Inbound Number for direct Twilio, not LC Phone). Replacement semantics: if you send twilioPhone in the request body, the stored map is replaced entirely with this object (not merged). Any location id omitted from the object is removed from the saved map. Omit the twilioPhone property entirely to leave existing numbers unchanged. Send an empty object {} to clear all per-location numbers. To clear a single location only, set that location id to an empty string "". Additional keys: see wildcard field |
twilioPhone.* | string | Additional keys | |
type | string | Optional | User account type (account for sub-account users, agency for agency-level users) |