---
title: "Start Contact Sync"
method: POST
path: "/api/v1/contact-sources/{source_key}/sync"
tags: ["businesses"]
---

# Start Contact Sync

`POST /api/v1/contact-sources/{source_key}/sync`

Start a sync for one source. 409 if one is already running.

``{source_key:path}`` because a PMS key is ``pms:<provider>`` and a bare
path parameter would stop at the colon.

## Path parameters

- `source_key` string, required

## Request body

- ContactSourceSyncRequest — Body for POST /contact-sources/{source_key}/sync.
  - `report_only` boolean

## Response `200`

Successful Response

- ImportRunRead — Status of a bulk-sync run, for the progress UI. ``source_key`` names the contact source, ``report_only`` says whether the run wrote anything, and ``counters`` holds the seven every source reports. The HubSpot-named counters are the legacy pair the current progress UI still reads.
  - `id` string, uuid, required
  - `provider` string, required
  - `source_key` string, required
  - `status` string, required
  - `phase` string, required
  - `report_only` boolean, required
  - `counters` object
  - `contacts_imported` integer, required
  - `contacts_updated` integer, required
  - `contacts_skipped` integer, required
  - `companies_imported` integer, required
  - `companies_updated` integer, required
  - `associations_made` integer, required
  - `error_message` string, nullable
  - `started_at` string, date-time, nullable
  - `finished_at` string, date-time, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getanana/cleon-api/revisions/c0f54348e251/schema)