Skip to main content
POST
/
users
Create User
curl --request POST \
  --url https://services.leadconnectorhq.com/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "companyId": "ve9EPM428h8vShlRW1KT",
  "firstName": "John",
  "lastName": "Deo",
  "email": "john@deo.com",
  "password": "*******",
  "type": "account",
  "role": "admin",
  "locationIds": [
    "C2QujeCh8ZnC7al2InWR"
  ],
  "phone": "+18832327657",
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true,
    "workflowsReadOnly": true,
    "triggersEnabled": true,
    "funnelsEnabled": true,
    "websitesEnabled": false,
    "opportunitiesEnabled": true,
    "dashboardStatsEnabled": true,
    "bulkRequestsEnabled": true,
    "appointmentsEnabled": true,
    "reviewsEnabled": true,
    "onlineListingsEnabled": true,
    "phoneCallEnabled": true,
    "conversationsEnabled": true,
    "assignedDataOnly": false,
    "adwordsReportingEnabled": false,
    "membershipEnabled": false,
    "facebookAdsReportingEnabled": false,
    "attributionsReportingEnabled": false,
    "settingsEnabled": true,
    "tagsEnabled": true,
    "leadValueEnabled": true,
    "marketingEnabled": true,
    "agentReportingEnabled": true,
    "botService": false,
    "socialPlanner": true,
    "bloggingEnabled": true,
    "invoiceEnabled": true,
    "affiliateManagerEnabled": true,
    "contentAiEnabled": true,
    "refundsEnabled": true,
    "recordPaymentEnabled": true,
    "cancelSubscriptionEnabled": true,
    "paymentsEnabled": true,
    "communitiesEnabled": true,
    "exportPaymentsEnabled": true
  },
  "scopes": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "scopesAssignedToOnly": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "profilePhoto": "https://img.png",
  "platformLanguage": "en_US"
}
'
{
  "id": "0IHuJvc2ofPAAA8GzTRi",
  "name": "John Deo",
  "firstName": "John",
  "lastName": "Deo",
  "email": "john@deo.com",
  "phone": "+1 808-868-8888",
  "extension": "",
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true,
    "workflowsReadOnly": true,
    "triggersEnabled": true,
    "funnelsEnabled": true,
    "websitesEnabled": false,
    "opportunitiesEnabled": true,
    "dashboardStatsEnabled": true,
    "bulkRequestsEnabled": true,
    "appointmentsEnabled": true,
    "reviewsEnabled": true,
    "onlineListingsEnabled": true,
    "phoneCallEnabled": true,
    "conversationsEnabled": true,
    "assignedDataOnly": false,
    "adwordsReportingEnabled": false,
    "membershipEnabled": false,
    "facebookAdsReportingEnabled": false,
    "attributionsReportingEnabled": false,
    "settingsEnabled": true,
    "tagsEnabled": true,
    "leadValueEnabled": true,
    "marketingEnabled": true,
    "agentReportingEnabled": true,
    "botService": false,
    "socialPlanner": true,
    "bloggingEnabled": true,
    "invoiceEnabled": true,
    "affiliateManagerEnabled": true,
    "contentAiEnabled": true,
    "refundsEnabled": true,
    "recordPaymentEnabled": true,
    "cancelSubscriptionEnabled": true,
    "paymentsEnabled": true,
    "communitiesEnabled": true,
    "exportPaymentsEnabled": true
  },
  "scopes": "campaigns.readonly",
  "roles": {
    "type": "account",
    "role": "admin",
    "locationIds": [
      "ve9EPM428h8vShlRW1KT"
    ],
    "restrictSubAccount": true
  },
  "lcPhone": {
    "locationId": "+1234556677"
  },
  "platformLanguage": "en_US"
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
​
companyId
string
required
Example:

"ve9EPM428h8vShlRW1KT"

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Deo"

​
email
string
required
Example:

"john@deo.com"

​
password
string
required
Example:

"*******"

​
type
string
required
Example:

"account"

​
role
string
required
Example:

"admin"

​
locationIds
string[]
required
Example:
["C2QujeCh8ZnC7al2InWR"]
​
phone
string
Example:

"+18832327657"

​
permissions
object
​
scopes
enum<string>[]

Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled

Available options:
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,
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.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,
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
Example:
["contacts.write", "campaigns.readonly"]
​
scopesAssignedToOnly
enum<string>[]

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

Available options:
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,
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.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,
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
Example:
["contacts.write", "campaigns.readonly"]
​
profilePhoto
string
Example:

"https://img.png"

​
platformLanguage
enum<string>

Platform language preference for the user

Available options:
en_US,
es,
fr_CA,
fr_FR,
nl,
de,
pt_PT,
pt_BR,
it,
sv,
da,
fi,
no
Example:

"en_US"

Response

Successful response

​
id
string
Example:

"0IHuJvc2ofPAAA8GzTRi"

​
name
string
Example:

"John Deo"

​
firstName
string
Example:

"John"

​
lastName
string
Example:

"Deo"

​
email
string
Example:

"john@deo.com"

​
phone
string
Example:

"+1 808-868-8888"

​
extension
string
Example:

""

​
permissions
object
​
scopes
enum<string>
Available options:
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,
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.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,
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
​
roles
object
​
lcPhone
object

LC Phone Inbound Phone Numbers

Example:
{ "locationId": "+1234556677" }
​
platformLanguage
enum<string>

Platform language preference for the user

Available options:
en_US,
es,
fr_CA,
fr_FR,
nl,
de,
pt_PT,
pt_BR,
it,
sv,
da,
fi,
no
Example:

"en_US"

Last modified on March 4, 2026