Skip to main content
POST
Pulls the CRM’s clients now with the saved rule, the app’s Sync now, instead of waiting for the nightly sync. It answers 202 when a pull started, and 200 with started: false and a reason when it did not: The two safeguards on every pull apply: a pull that stops before the end removes nothing, and one that would remove more than half of that CRM’s clients while the rule has not changed is held. See CRM rule.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
provider
enum<string>
required

The CRM whose client rule to use. It must be connected to your workspace.

Available options:
hubspot,
salesforce,
attio

Response

The sync did not start, and the response gives the reason

​
success
boolean
Example:

true

​
data
object