LinkedIn Activity API
Overview
With Dux-Soup LinkedIn Activity API you can trigger automated LinkedIn actions from outside of the web browser. This means that you can e.g. trigger sending a connection request, including a personalised message, to a specific profile in LinkedIn from e.g. Hubspot. You can trigger this when a new lead is created and their LinkedIn profile URL is added. This API enables you to include LinkedIn campaigns without leaving your lead management system!
LinkedIn Activity Commands
The LinkedIn Activity API supports the following LinkedIn Activity commands. When these commands are sent to the Dux-Soup servers, they will wait in a queue. They will remain in the queue for up to 365 days to be picked up by the Dux-Soup extension.
A successful call returns the messageid of the queued message. Repeated identical calls will not result in multiple queue entries, instead the API will return the ID of the message that is already in the queue. The messageid is included in all webhook events generated by the extension, and thus enables the correlation of the activity that was scheduled, with the subsequent events that are generated as the activity is executed.
Visit
This command will open the target profile in a new tab on the remote. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST,
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "visit" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Enroll
This command will open the target profile in a new tab and enrolls the profile into the specified campaign. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "enroll" | |
| params | { | |
| campaignid | Campaign ID of the campaign the profile should be enrolled into ( mandatory, String ) | |
| profile | Target profile URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Connect
This will open the target profile in a new tab and will attempt to send a personalised connection request. After the command has executed the remote will close the tab.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "connect" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a 2nd or 3rd degree connection ( mandatory, String ) | |
| messagetext | Personalised message to be sent with the invite. Can contain placeholders, e.g. _FN_ ( optional, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Message
This will open the target profile in a new tab and will attempt to send a direct message. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "message" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a 1st degree connection ( mandatory, String ) | |
| messagetext | Personalised message to be sent. Can contain placeholders, e.g. _FN_ ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
InMail
This will open the target profile in a new tab and will attempt to send an InMail message. This requires your LinkedIn account to have InMail credits. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "inmail" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a Sales Navigator or Recruiter URL ( mandatory, String ) | |
| messagesubject | Personalised subject for the InMail. Can contain placeholders, e.g. A message for _FN_ ( mandatory, String ) | |
| messagetext | Personalised message to be sent. Can contain placeholders, e.g. Hi _FN_ ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Tag
This will open the target profile in a new tab and will apply one or more Dux-Soup tags to the profile. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "tag" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL ( mandatory, String ) | |
| tags | List of tags to add ( mandatory, Array of Strings ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Untag
This will open the target profile in a new tab and will remove one or more Dux-Soup tags from the profile. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "untag" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL ( mandatory, String ) | |
| tags | List of tags to remove ( mandatory, Array of Strings ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
SaveToPdf
This will open the target profile in a new tab and will save the profile as a PDF. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "savetopdf" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a regular LinkedIn URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Follow
This will open the target profile in a new tab and will 'follow' the profile. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "follow" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a regular LinkedIn URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Disconnect
This will open the target profile in a new tab and will disconnect the profile. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "savetopdf" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a 1st degree, regular LinkedIn URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Endorse
This will open the target profile in a new window and will attempt to endorse the selected skills. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "savetopdf" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a 1st degree, regular LinkedIn URL ( mandatory, String ) | |
| count | Number of skills to endorse, e.g. 3 for top 3 or -1 for bottom 1. ( optional, Number, defaults to 3 ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
SaveAsLead
This will open the target profile in a new window and save the profile to the "My saved lead" list. After the command has executed the tab is closed.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue
- HTTP method: POST
- HTTP body: a JSON object with the following attributes, in addition to the required fields.
| command | "saveaslead" | |
| params | { | |
| campaignid | Campaign ID to be assigned to this command ( optional, String ) | |
| profile | Target profile URL, must be a Sales Navigator URL ( mandatory, String ) | |
| } | ||
| runafter | Schedule the command to run after a set time ( optional, ISO date-string) | |
| force | Force the action, ignoring all exclusion rules ( optional, boolean ) | |
Enabling Remote Control
Remote Control Needs to be enabled in Dux-Soup Options -> Connect Tab. Simply toggle the switch to enable your Dux-Soup Extension to receive LinkedIn Activity commands:
[1] Remote Control is only available in Dux-Soup Turbo Edition