Link Account to Squid
Account
Link Account to Squid
Attach a platform account to a squid so account-based scrapers can authenticate
POST
Link Account to Squid
Some scrapers require a connected platform account to run (LinkedIn, Facebook, Sales Navigator, etc.). Link one or more accounts to a squid by passing their hash IDs in the
The
accounts array when updating the squid.
Only scrapers that require authentication have an
accounts field. For public scrapers (Google Maps, Trustpilot, etc.) this field is ignored.Headers
Your API authentication token. Value:
Token YOUR_API_KEYRequest body format. Value:
application/jsonPath Parameters
The hash of the squid to update
Body Parameters
Array of account hash strings to link to the squid. Pass an empty array
[] or null to remove all linked accounts. Each hash must correspond to an account of the correct type for the scraper.How to find your account hash
Use List Accounts to retrieve your connected accounts and theirid (hash) values:
id field in each account object is the hash you pass in the accounts array.
Code Examples
Response
200
Removing linked accounts
Pass an empty array to unlink all accounts from a squid:Errors
| Error | Cause |
|---|---|
AccountDoesNotExist | One of the account hashes was not found or doesn’t belong to you |
InvalidParamType | accounts is not an array, or contains non-string values |