Skip to main content
POST
/
v3
/
integrations
/
{integration_uid}
/
accounts
Add or Update an Integration Account
curl --request POST \
  --url https://api.captaindata.co/v3/integrations/{integration_uid}/accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <api-key>' \
  --data '
{
  "account": {
    "uid": "Pass this UID to update an account only",
    "name": "Your account",
    "cookies": {
      "li_at": "YOUR_SESSION_COOKIE"
    },
    "user_uid": "67890-wxyz"
  },
  "resume_paused_jobs": false,
  "shared_account": false,
  "retrieve_ip": false
}
'
{
  "message": "Integration configured.",
  "account": {
    "api_key": null,
    "cookies": {
      "li_at": "YOUR_SESSION_COOKIE"
    },
    "integration_permalink": "linkedin",
    "is_shared": false,
    "name": "New account",
    "password": null,
    "setup_at": "Fri, 02 Oct 2020 13:34:38 GMT",
    "uid": "xxxxxx-d339-4206-a4fb-a1fc8cc55eb7",
    "user_id": null,
    "username": null,
    "via_extension": false,
    "level": null
  }
}

Authorizations

​
Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

​
x-project-id
string
header
required

Workspace UID required to identify the workspace.

Path Parameters

​
integration_uid
string
required

The slug of the integration, such as 'linkedin', used to create a new account of this type.

Body

application/json
​
account
Account · object

The account JSON object to create or update.

Example:
{
  "uid": "Pass this UID to update an account only",
  "name": "Your account",
  "cookies": { "li_at": "YOUR_SESSION_COOKIE" },
  "user_uid": "67890-wxyz"
}
​
resume_paused_jobs
boolean
default:false

Set this to true to resume all paused jobs if you update, for example, an account's cookie.

Example:

false

​
shared_account
boolean
default:false

Set this to true to share this account to an external user.

Example:

false

​
retrieve_ip
boolean
default:false

Set this to true to retrieve the IP we attribute to the user/account.

Example:

false

Response

Successful Response