User Settings API
Overview
The User Settings API is aimed at super-users who manage the LinkedIn outreach of multiple accounts. It enables the reading and writing of all user configurable settings of the Dux-Soup extension and the Dux-Dash. With this you can e.g. change the times in the planner, or change the daily invite limits for a specific Dux-Soup account, without requiring access to the extension via the browser menu!
Reading Settings
This API call retrieves all user settings.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/settings
- HTTP method: GET
- No additional parameters, just the required fields.
Writing Settings
Set any number of user settings.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following parameters, in addition to the required fields.
settings | A JSON object containing the desired key-value pairs of the updated settings. |
Available Settings
The following settings are available:
actionnotifications | category | description | ||
activefollowupcampaignid | category | description | ||
affiliatelicense | category | description | ||
autoconnect | category | description | ||
autoconnectmessageflag | category | description | ||
autoconnectmessagetext | category | description | ||
autodisconnect | category | description | ||
autoendorse | category | description | ||
autoendorsetarget | category | description | ||
autofollow | category | description | ||
autopdf | category | description | ||
autosaveaslead | category | description | ||
autotagflag | category | description | ||
autotagvalue | category | description | ||
backgroundmode | category | description | ||
badgedisplay | category | description | ||
buymail | category | description | ||
campaigns | category | description | ||
connectedmessageflag | category | description | ||
connectedmessagetext | category | description | ||
excludeblacklistedaction | category | description | ||
excludeblacklistedfollowup | category | description | ||
excludelowconnectioncountaction | category | description | ||
excludelowconnectioncountvalue | category | description | ||
excludetagskippedaction | category | description | ||
expand | category | description | ||
expirependinginvitesflag | category | description | ||
expirependinginvitesvalue | category | description | ||
followupflag | category | description | ||
followupforallflag | category | description | ||
infonotifications | category | description | ||
killcharacters | category | description | ||
killwords | category | description | ||
linkedinlimitalert | category | description | ||
linkedinlimitsnooze | category | description | ||
manageddownload | category | description | ||
maxenrolls | category | description | ||
maxinvites | category | description | ||
maxmessages | category | description | ||
maxpageloadtime | category | description | ||
maxvisits | category | description | ||
messagebridgeflag | category | description | ||
messagebridgeinterval | category | description | ||
minimisedstools | category | description | ||
pageinitdelay | category | description | ||
pauseoninviteerror | category | description | ||
previsitdialog | category | description | ||
randomrange | category | description | ||
remotecontrolflag | category | description | ||
resumedelayoninviteerror | category | description | ||
robotscheduleplan | category | description | ||
runautomationsonmanualvisits | category | description | ||
scanthrottletime | category | description | ||
sendinmailbody | category | description | ||
sendinmailflag | category | description | ||
sendinmailsubject | category | description | ||
skip3plus | category | description | ||
skipcustomflag | category | description | ||
skipcustomvalue | category | description | ||
skipdays | category | description | ||
skipincrm | category | description | ||
skipnoimage | category | description | ||
skipnoinfluencer | category | description | ||
skipnojobseeker | category | description | ||
skipnolion | category | description | ||
skipnoname | category | description | ||
skipnopremium | category | description | ||
skiptaggedflag | category | description | ||
skiptaggedvalue | category | description | ||
throttletime | category | description | ||
waitminutes | category | description | ||
waitvisits | category | description | ||
warningnotifications | category | description | ||
webhookprofileflag | category | description | ||
webhooks | category | description |