---
title: "Create CRM sync preview"
method: POST
path: "/api/integrations/crm/connections/{id}/sync-runs"
tags: ["CRM"]
---

# Create CRM sync preview

`POST /api/integrations/crm/connections/{id}/sync-runs`

## Request

- Base URL: `https://api.setluca.com`
- URL: `https://api.setluca.com/api/integrations/crm/connections/{id}/sync-runs`
- Auth: one of:
  - API key in cookie `luca.session_token`
  - API key in header `x-api-key`
  - HTTP bearer

A dry run previews mapped changes without writing to the CRM. Live sync is unavailable.

**API key scopes:** `integrations:write`. You also need an `Idempotency-Key` header.

## Path parameters

- `id` string, uuid, required

## Headers

- `Luca-API-Version` '1'

## Request body

- CrmSyncRunCreate
  - `mode` 'dry_run' | 'live'
  - `direction` 'luca_to_crm' | 'crm_to_luca' | 'bidirectional'

## Response `200`

ok

- CrmSyncRun
  - `id` string, uuid, required
  - `connectionId` string, uuid, required
  - `provider` 'gohighlevel' | 'hubspot' | 'activecampaign' | 'salesforce' | 'pipedrive', required
  - `mode` 'dry_run' | 'live', required
  - `direction` 'luca_to_crm' | 'crm_to_luca' | 'bidirectional', required
  - `status` 'planned' | 'applied' | 'failed' | 'cancelled', required
  - `plannedMutations` object[], required
    - `action` string, required
    - `resource` 'contact' | 'deal' | 'note' | 'tag' | 'field', required
    - `externalId` string
    - `lucaId` string
    - `fields` object, required: Opaque JSON object
    - `dangerous` boolean
  - `appliedMutations` object[], required
    - `action` string, required
    - `resource` 'contact' | 'deal' | 'note' | 'tag' | 'field', required
    - `externalId` string
    - `lucaId` string
    - `fields` object, required: Opaque JSON object
    - `dangerous` boolean
  - `conflictReport` unknown, required
  - `error` string, nullable, required
  - `createdAt` string, required
  - `completedAt` string, nullable, required

## Other responses

- `400`: bad request
- `401`: unauthorized
- `403`: forbidden
- `404`: not found
- `429`: rate limited
- `500`: internal error
- `503`: service unavailable

---

[API](https://skmtc.dev/setluca/apis/luca-api.md) · [All operations](https://skmtc.dev/setluca/apis/luca-api/llms.txt) · [OpenAPI document](https://skmtc.dev/setluca/apis/luca-api/revisions/90a200e4100b?raw)