Skip to main content
POST
Map an account on LinkedIn

Authorizations

X-API-Key
string
header
required

Path Parameters

account_key
string
required

The account's key: its domain (acme.com), or its LinkedIn page (li-co:acme).

Required string length: 1 - 320
Pattern: ^(?:[^/.][^/]*|\.[^/.][^/]*|\.\.[^/]+)$

Body

application/json

Map an account's company on LinkedIn through a sender.

sender_profile_id
string<uuid>
required

The sender whose LinkedIn opens the company's page and searches its people. Each page and each person read counts toward their daily limits.

company_url
string | null

The company's LinkedIn page. Omitted, the page the account's rows give; an account with none needs it.

Required string length: 1 - 512
fast
boolean
default:true

Read the company page and search its people a minute or two apart, fitting between the sender's other steps, instead of waiting the sender's Time between steps (on their LinkedIn tab) before each. The price and the daily limits stay the same. False waits it like any other step.

Response

Successful Response

An account's Map on LinkedIn: what it costs, which page it reads, and the newest map.

company_url
string | null
required

The company page a map reads: the one asked about, else the account's.

map
AccountLinkedInMapStateSchema · object | null
required

The newest map of the company, or null when it was never mapped.

max_credits
number
required

The most one map costs: the company page and each person the search reads, 0.1 credits each.