API Reference
Create Unipile AccountDashboardWebsite

Connect an account (native authentication)

post
https://{subdomain}.unipile.com:{port}/api/v1/accounts

Link to Uniple an account of the given type and provider.

Body Params

The parameters required to perform the authentication depend on the type of account you are trying to connect.

string
length between 2 and 2

An ISO 3166-1 A-2 country code to be set as proxy's location.

string

An IPv4 address to infer proxy's location.

disabled_features
array of strings

An array of features that should be disabled for this account.

disabled_features
sync_limit
object

Set a sync limit either for chats, messages or both. Chats limit will apply to each inbox, whereas messages limit will apply to each chat. No value will not apply any limit (default behaviour). Providers partial support.

string
enum
required
Allowed:
proxy
object
string

If encountering disconnection issues, enter the exact user agent of the browser on which the account has been connected. You can easily retrieve it in the browser's console with this command : "console.log(navigator.userAgent)"

string

The contract that should be used with Linkedin Recruiter.

string
required

Should be either an email address or a phone number.

string
required
Responses

Updated about 1 month ago

Language
Credentials
Header
URL
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago