Skip to main content
PUT
Put a connector already in your network into one of your connector slots. Connectors in a slot are re-imported automatically by the connector-refresh automation, on its schedule, so their book stays current without anyone re-running the import.
A slot is a promise to spend. Every scheduled refresh imports each connector in a slot again, and an import spends credits per connector. Your plan bounds how many slots you have (limit in the answer); a workspace with no slots gets 403, a full roster gets 409.
Setting the slot starts no job and spends no credits: the next run of the schedule, or Run Connector Refresh, does the work. in_slot on List Connectors shows who is in one.

Releasing a slot

DELETE on the same path takes the connector out. They stay in the network with every opportunity they have; only the automatic refresh stops. Idempotent, like the PUT.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Path Parameters

connector_id
string
required

The connector's per_ Clustr id, as GET /v2/people returns it. The LinkedIn slug works too.

Response

Typed result envelope.

success
boolean
required
data
object
required