Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer <credential>, where the credential is either:

  • an API key (sk_…), generated by an organization admin in Settings, for scripts and automation;
  • an access token from tth auth login (the TalkToHumans CLI), which any member of the workspace can use.

Both resolve to the same organization and user. A login token acts in the user's workspace: one with no workspace yet returns 403 workspace_setup_required, and one in several workspaces returns 403 forbidden (use an API key instead).

Path Parameters

​
contact_id
string
required

Contact ID returned by GET /v1/contacts. The user's own posts are tracked by the "Track my posts" setting instead.

Pattern: ^[1-9][0-9]*$

Body

application/json
​
account_id
string

LinkedIn account ID returned by GET /v1/accounts. Required when the organization has multiple LinkedIn accounts.

Pattern: ^[1-9][0-9]*$
​
enabled
boolean
default:true

false stops tracking and keeps the engagers already imported.

Response

The contact's tracking. Starting it runs the first check now, then one every day: each check costs 2 credits, plus 2 per 100 engagers new to the workspace, until it is stopped. Read the engagers with GET /v1/contacts?view_id={engagers_view_id}. Asking for the state it is already in changes nothing and costs nothing.

​
data
object
required