Update User

put

https://services.leadconnectorhq.com/users/{userId}

Request

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Body

firstName

string

Example:

John

lastName

string

Example:

Deo

string

deprecated

Email update is no longer supported due to security reasons.

Example:

john@deo.com

emailChangeOTP

string

OTP to change the email ID of the user

Example:

191344

password

string

Example:

*******

phone

string

Example:

+18832327657

isEjectedUser

boolean

required

Example:

true

type

string

Example:

account

role

string

Example:

admin

companyId

string

Company/Agency Id. Required for Agency Level access

Example:

UAXssdawIWAWD

locationIds

array[string]

Example:

["C2QujeCh8ZnC7al2InWR"]

permissions

object

campaignsEnabled

boolean

Default:

true

Example:

true

campaignsReadOnly

boolean

Default:

false

Example:

false

contactsEnabled

boolean

Default:

true

Example:

true

workflowsEnabled

boolean

Default:

true

Example:

true

workflowsReadOnly

boolean

Default:

false

Example:

true

triggersEnabled

boolean

Default:

true

Example:

true

funnelsEnabled

boolean

Default:

true

Example:

true

websitesEnabled

boolean

Default:

false

Example:

false

opportunitiesEnabled

boolean

Default:

true

Example:

true

dashboardStatsEnabled

boolean

Default:

true

Example:

true

bulkRequestsEnabled

boolean

Default:

true

Example:

true

appointmentsEnabled

boolean

Default:

true

Example:

true

reviewsEnabled

boolean

Default:

true

Example:

true

onlineListingsEnabled

boolean

Default:

true

Example:

true

phoneCallEnabled

boolean

Default:

true

Example:

true

conversationsEnabled

boolean

Default:

true

Example:

true

assignedDataOnly

boolean

Default:

false

Example:

false

adwordsReportingEnabled

boolean

Default:

false

Example:

false

membershipEnabled

boolean

Default:

false

Example:

false

facebookAdsReportingEnabled

boolean

Default:

false

Example:

false

attributionsReportingEnabled

boolean

Default:

false

Example:

false

settingsEnabled

boolean

Default:

true

Example:

true

tagsEnabled

boolean

Default:

true

Example:

true

leadValueEnabled

boolean

Default:

true

Example:

true

marketingEnabled

boolean

Default:

true

Example:

true

agentReportingEnabled

boolean

Default:

true

Example:

true

botService

boolean

Default:

false

Example:

false

socialPlanner

boolean

Default:

true

Example:

true

bloggingEnabled

boolean

Default:

true

Example:

true

invoiceEnabled

boolean

Default:

true

Example:

true

affiliateManagerEnabled

boolean

Default:

true

Example:

true

contentAiEnabled

boolean

Default:

true

Example:

true

refundsEnabled

boolean

Default:

true

Example:

true

recordPaymentEnabled

boolean

Default:

true

Example:

true

cancelSubscriptionEnabled

boolean

Default:

true

Example:

true

paymentsEnabled

boolean

Default:

true

Example:

true

communitiesEnabled

boolean

Default:

true

Example:

true

exportPaymentsEnabled

boolean

Default:

true

Example:

true

scopes

array[string]

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

Allowed values:

campaigns.readonlycampaigns.writecalendars/events.writecalendars/events.readonlycontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.writewebsites.writemedias.writemedias.readonlyopportunities.writeopportunities/leadValue.readonlyopportunities/bulkActions.writereporting/phone.readonlyreporting/adwords.readonlyreporting/facebookAds.readonlyreporting/attributions.readonlyreporting/agent.readonlyreporting/reports.writereporting/reports.readonlypayments.writepayments/refunds.writepayments/records.writepayments/exports.writepayments/subscriptionsCancel.writeinvoices.writeinvoices.readonlyinvoices/schedule.readonlyinvoices/schedule.writeinvoices/template.readonlyinvoices/template.writereputation/review.writereputation/listing.writeconversations.writeconversations.readonlyconversations/message.readonlyconversations/message.writecontentAI.writedashboard/stats.readonlylocations/tags.writelocations/tags.readonlymarketing.writeeliza.writesettings.writesocialplanner/post.writesocialplanner/account.readonlysocialplanner/account.writesocialplanner/category.readonlysocialplanner/category.writesocialplanner/csv.readonlysocialplanner/csv.writesocialplanner/group.writesocialplanner/hashtag.readonlysocialplanner/hashtag.writesocialplanner/oauth.readonlysocialplanner/oauth.writesocialplanner/post.readonlysocialplanner/recurring.readonlysocialplanner/recurring.writesocialplanner/review.readonlysocialplanner/review.writesocialplanner/rss.readonlysocialplanner/rss.writesocialplanner/search.readonlysocialplanner/setting.readonlysocialplanner/setting.writesocialplanner/stat.readonlysocialplanner/tag.readonlysocialplanner/tag.writesocialplanner/filters.readonlysocialplanner/medias.readonlysocialplanner/medias.writesocialplanner/watermarks.readonlysocialplanner/watermarks.writesocialplanner/metatag.readonlysocialplanner/facebook.readonlysocialplanner/linkedin.readonlysocialplanner/twitter.readonlysocialplanner/notification.readonlysocialplanner/notification.writesocialplanner/snapshot.readonlysocialplanner/snapshot.writemarketing/affiliate.writeblogs.writemembership.writecommunities.writecertificates.writecertificates.readonlyadPublishing.writeadPublishing.readonlyprospecting.writeprospecting.readonlyprospecting/reports.readonlyprivate-integration-location.readonlyprivate-integration-location.writeprivate-integration-company.readonlyprivate-integration-company.writenative-integrations.readonlynative-integrations.writewordpress.writewordpress.readcustom-menu-link.writeusers/team-management.writeusers/team-management.readonly

Example:

["contacts.write","campaigns.readonly"]

scopesAssignedToOnly

array[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

Allowed values:

Example:

["contacts.write","campaigns.readonly"]

profilePhoto

string

Example:

https://img.png

Headers

Authorization

string

required

Access Token

Example:

Bearer 9c48df2694a849b6089f9d0d3513efe

Version

string

required

API Version

Allowed value:

2021-07-28

Responses

200

Successful response

Body

string

Example:

0IHuJvc2ofPAAA8GzTRi

name

string

Example:

John Deo

firstName

string

Example:

John

lastName

string

Example:

Deo

string

Example:

john@deo.com

phone

string

Example:

+1 808-868-8888

extension

string

Example:

permissions

object

campaignsEnabled

boolean

Default:

true

Example:

true

campaignsReadOnly

boolean

Default:

false

Example:

false

contactsEnabled

boolean

Default:

true

Example:

true

workflowsEnabled

boolean

Default:

true

Example:

true

workflowsReadOnly

boolean

Default:

false

Example:

true

triggersEnabled

boolean

Default:

true

Example:

true

funnelsEnabled

boolean

Default:

true

Example:

true

websitesEnabled

boolean

Default:

false

Example:

false

opportunitiesEnabled

boolean

Default:

true

Example:

true

dashboardStatsEnabled

boolean

Default:

true

Example:

true

bulkRequestsEnabled

boolean

Default:

true

Example:

true

appointmentsEnabled

boolean

Default:

true

Example:

true

reviewsEnabled

boolean

Default:

true

Example:

true

onlineListingsEnabled

boolean

Default:

true

Example:

true

phoneCallEnabled

boolean

Default:

true

Example:

true

conversationsEnabled

boolean

Default:

true

Example:

true

assignedDataOnly

boolean

Default:

false

Example:

false

adwordsReportingEnabled

boolean

Default:

false

Example:

false

membershipEnabled

boolean

Default:

false

Example:

false

facebookAdsReportingEnabled

boolean

Default:

false

Example:

false

attributionsReportingEnabled

boolean

Default:

false

Example:

false

settingsEnabled

boolean

Default:

true

Example:

true

tagsEnabled

boolean

Default:

true

Example:

true

leadValueEnabled

boolean

Default:

true

Example:

true

marketingEnabled

boolean

Default:

true

Example:

true

agentReportingEnabled

boolean

Default:

true

Example:

true

botService

boolean

Default:

false

Example:

false

socialPlanner

boolean

Default:

true

Example:

true

bloggingEnabled

boolean

Default:

true

Example:

true

invoiceEnabled

boolean

Default:

true

Example:

true

affiliateManagerEnabled

boolean

Default:

true

Example:

true

contentAiEnabled

boolean

Default:

true

Example:

true

refundsEnabled

boolean

Default:

true

Example:

true

recordPaymentEnabled

boolean

Default:

true

Example:

true

cancelSubscriptionEnabled

boolean

Default:

true

Example:

true

paymentsEnabled

boolean

Default:

true

Example:

true

communitiesEnabled

boolean

Default:

true

Example:

true

exportPaymentsEnabled

boolean

Default:

true

Example:

true

scopes

string

Allowed values:

roles

object

type

string

Example:

account

role

string

Example:

admin

locationIds

array[string]

Example:

["ve9EPM428h8vShlRW1KT"]

restrictSubAccount

boolean

Example:

true

lcPhone

object

LC Phone Inbound Phone Numbers

Example:

{"locationId":"+1234556677"}

422

Unprocessable Entity

Body

statusCode

number

Example:

422

message

array[string]

Example:

["Unprocessable Entity"]

error

string

Example:

Unprocessable Entity

401

Unauthorized

Body

statusCode

number

Example:

401

message

string

Example:

Invalid token: access token is invalid

error

string

Example:

Unauthorized

400

Bad Request

Body

statusCode

number

Example:

400

message

string

Example:

Bad Request

Update User

Update User

Request

Security: Bearer Auth (Agency-Access)

Security: Bearer Auth (Location-Access)

Body

Headers

Responses

200

Body

422

Body

401

Body

400

Body