Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

Create User 
POST https://services.leadconnectorhq.com/users/

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version de la API.

​
Body

​
companyId
string
default:"ve9EPM428h8vShlRW1KT"
required
​
firstName
string
default:"John"
required
​
lastName
string
default:"Deo"
required
​
email
string
default:"john@deo.com"
required
​
password
string
default:"*******"
required
​
phone
string
default:"+18832327657"
​
type
string
default:"account"
required
​
role
string
default:"admin"
required
​
locationIds
string[]
required
​
permissions
object
​
scopes
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
​
scopesAssignedToOnly
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
​
profilePhoto
string
default:"https://img.png"
​
twilioPhone
object
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
default:"en_US"
Platform language preference for the user Posibles valores: ‘en_US’, ‘es’, ‘fr_CA’, ‘fr_FR’, ‘nl’, ‘de’, ‘pt_PT’, ‘pt_BR’, ‘it’, ‘sv’, ‘da’, ‘fi’, ‘no’

​
Respuestas

​
id
string
default:"0IHuJvc2ofPAAA8GzTRi"
​
name
string
default:"John Deo"
​
firstName
string
default:"John"
​
lastName
string
default:"Deo"
​
email
string
default:"john@deo.com"
​
phone
string
default:"+1 808-868-8888"
​
extension
string
default:""
​
permissions
object
​
scopes
string
Posibles valores: ‘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
​
lcPhone
object
LC Phone Inbound Phone Numbers
​
platformLanguage
string
default:"en_US"
Platform language preference for the user Posibles valores: ‘en_US’, ‘es’, ‘fr_CA’, ‘fr_FR’, ‘nl’, ‘de’, ‘pt_PT’, ‘pt_BR’, ‘it’, ‘sv’, ‘da’, ‘fi’, ‘no’
{
  "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
}

{}

{}

{}

​
Ejemplo

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"
}'