Create User
POST https://services.leadconnectorhq.com/users/Authorization
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | Bearer token generated from the Leadway portal. See Authentication. | |
Version | string | Yes | 2021-07-28 | API version. |
Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
companyId | string | Yes | ve9EPM428h8vShlRW1KT | |
firstName | string | Yes | John | |
lastName | string | Yes | Deo | |
email | string | Yes | john@deo.com | |
password | string | Yes | ******* | |
phone | string | No | +18832327657 | |
type | string | Yes | account | |
role | string | Yes | admin | |
locationIds | string[] | Yes |
permissions(object)campaignsEnabled(boolean): Example:TruecampaignsReadOnly(boolean): Example:FalsecontactsEnabled(boolean): Example:TrueworkflowsEnabled(boolean): Example:TrueworkflowsReadOnly(boolean): Example:TruetriggersEnabled(boolean): Example:TruefunnelsEnabled(boolean): Example:TruewebsitesEnabled(boolean): Example:FalseopportunitiesEnabled(boolean): Example:TruedashboardStatsEnabled(boolean): Example:TruebulkRequestsEnabled(boolean): Example:TrueappointmentsEnabled(boolean): Example:TruereviewsEnabled(boolean): Example:TrueonlineListingsEnabled(boolean): Example:TruephoneCallEnabled(boolean): Example:TrueconversationsEnabled(boolean): Example:TrueassignedDataOnly(boolean): Example:FalseadwordsReportingEnabled(boolean): Example:FalsemembershipEnabled(boolean): Example:FalsefacebookAdsReportingEnabled(boolean): Example:FalseattributionsReportingEnabled(boolean): Example:FalsesettingsEnabled(boolean): Example:TruetagsEnabled(boolean): Example:TrueleadValueEnabled(boolean): Example:TruemarketingEnabled(boolean): Example:TrueagentReportingEnabled(boolean): Example:TruebotService(boolean): Example:FalsesocialPlanner(boolean): Example:TruebloggingEnabled(boolean): Example:TrueinvoiceEnabled(boolean): Example:TrueaffiliateManagerEnabled(boolean): Example:TruecontentAiEnabled(boolean): Example:TruerefundsEnabled(boolean): Example:TruerecordPaymentEnabled(boolean): Example:TruecancelSubscriptionEnabled(boolean): Example:TruepaymentsEnabled(boolean): Example:TruecommunitiesEnabled(boolean): Example:TrueexportPaymentsEnabled(boolean): Example:True
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
scopes | string[] | No | Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled | |
scopesAssignedToOnly | string[] | No | 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 | |
profilePhoto | string | No | https://img.png | |
twilioPhone | object | No | Per-account inbound Twilio number in E.164 format, keyed by account 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 account 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-account numbers. To clear a single account only, set that account id to an empty string "". | |
platformLanguage | string | No | en_US | Platform language preference for the user Possible values: 'en_US', 'es', 'fr_CA', 'fr_FR', 'nl', 'de', 'pt_PT', 'pt_BR', 'it', 'sv', 'da', 'fi', 'no' |
Responses
201 - Successful response
id(string): Example:0IHuJvc2ofPAAA8GzTRiname(string): Example:John DeofirstName(string): Example:JohnlastName(string): Example:Deoemail(string): Example:john@deo.comphone(string): Example:+1 808-868-8888extension(string)permissions(object)campaignsEnabled(boolean): Example:TruecampaignsReadOnly(boolean): Example:FalsecontactsEnabled(boolean): Example:TrueworkflowsEnabled(boolean): Example:TrueworkflowsReadOnly(boolean): Example:TruetriggersEnabled(boolean): Example:TruefunnelsEnabled(boolean): Example:TruewebsitesEnabled(boolean): Example:FalseopportunitiesEnabled(boolean): Example:TruedashboardStatsEnabled(boolean): Example:TruebulkRequestsEnabled(boolean): Example:TrueappointmentsEnabled(boolean): Example:TruereviewsEnabled(boolean): Example:TrueonlineListingsEnabled(boolean): Example:TruephoneCallEnabled(boolean): Example:TrueconversationsEnabled(boolean): Example:TrueassignedDataOnly(boolean): Example:FalseadwordsReportingEnabled(boolean): Example:FalsemembershipEnabled(boolean): Example:FalsefacebookAdsReportingEnabled(boolean): Example:FalseattributionsReportingEnabled(boolean): Example:FalsesettingsEnabled(boolean): Example:TruetagsEnabled(boolean): Example:TrueleadValueEnabled(boolean): Example:TruemarketingEnabled(boolean): Example:TrueagentReportingEnabled(boolean): Example:TruebotService(boolean): Example:FalsesocialPlanner(boolean): Example:TruebloggingEnabled(boolean): Example:TrueinvoiceEnabled(boolean): Example:TrueaffiliateManagerEnabled(boolean): Example:TruecontentAiEnabled(boolean): Example:TruerefundsEnabled(boolean): Example:TruerecordPaymentEnabled(boolean): Example:TruecancelSubscriptionEnabled(boolean): Example:TruepaymentsEnabled(boolean): Example:TruecommunitiesEnabled(boolean): Example:TrueexportPaymentsEnabled(boolean): Example:True
scopes(string): Possible 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', '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', '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-account.readonly', 'private-integration-account.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.account-transfer.write', 'internaltools.account-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/account.write', 'launchpad/account.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', 'accounts.create', 'accounts.delete', 'accounts.export.list', 'accounts.features-limits.manage', 'accounts.pause-resume', 'accounts.agency-accounts.manage', 'accounts.billing.manage', 'accounts.details.manage', 'audit-logs.readonly', 'audit-logs.export'roles(object)type(string): Example:accountrole(string): Example:adminlocationIds(string[])restrictSubAccount(boolean): Example:True
lcPhone(object): LC Phone Inbound Phone NumbersplatformLanguage(string): Platform language preference for the user Possible values: 'en_US', 'es', 'fr_CA', 'fr_FR', 'nl', 'de', 'pt_PT', 'pt_BR', 'it', 'sv', 'da', 'fi', 'no' Example: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,
// truncado: 23 lineas mas
}400 - Bad Request
{}422 - Unprocessable Entity
{}Example
curl -X POST 'https://services.leadconnectorhq.com/users/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"companyId": "ve9EPM428h8vShlRW1KT",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"password": "*******",
"phone": "+18832327657",
"type": "account",
"role": "admin",
"locationIds": [
"C2QujeCh8ZnC7al2InWR"
],
"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",
"twilioPhone": {
"C2QujeCh8ZnC7al2InWR": "+18832327657",
"M2QrtfVt8ZnC7cv2InDL": "+18832327657"
},
"platformLanguage": "en_US"
}'const response = await fetch('https://services.leadconnectorhq.com/users/', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"companyId": "ve9EPM428h8vShlRW1KT", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "phone": "+18832327657", "type": "account", "role": "admin", "locationIds": ["C2QujeCh8ZnC7al2InWR"], "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", "twilioPhone": {"C2QujeCh8ZnC7al2InWR": "+18832327657", "M2QrtfVt8ZnC7cv2InDL": "+18832327657"}, "platformLanguage": "en_US"}),
});
const data = await response.json();import os, requests
response = requests.request(
'POST',
'https://services.leadconnectorhq.com/users/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"companyId": "ve9EPM428h8vShlRW1KT", "firstName": "John", "lastName": "Deo", "email": "john@deo.com", "password": "*******", "phone": "+18832327657", "type": "account", "role": "admin", "locationIds": ["C2QujeCh8ZnC7al2InWR"], "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", "twilioPhone": {"C2QujeCh8ZnC7al2InWR": "+18832327657", "M2QrtfVt8ZnC7cv2InDL": "+18832327657"}, "platformLanguage": "en_US"},
)
data = response.json()<?php
$ch = curl_init('https://services.leadconnectorhq.com/users/');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'companyId': 've9EPM428h8vShlRW1KT', 'firstName': 'John', 'lastName': 'Deo', 'email': 'john@deo.com', 'password': '*******', 'phone': '+18832327657', 'type': 'account', 'role': 'admin', 'locationIds': ['C2QujeCh8ZnC7al2InWR'], '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', 'twilioPhone': {'C2QujeCh8ZnC7al2InWR': '+18832327657', 'M2QrtfVt8ZnC7cv2InDL': '+18832327657'}, 'platformLanguage': 'en_US'}),
]);
$data = json_decode(curl_exec($ch), true);