CRM

Create or update CRM connection

Creates or updates the CRM connection for a provider. We verify the credentials before storing them, so a bad key fails here instead of at the first sync.

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

post/api/integrations/crm/connections

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/integrations/crm/connections
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Request body

provider'gohighlevel' | 'hubspot' | 'activecampaign' | 'salesforce' | 'pipedrive' required
credentialsRefstring required
settingsobject

Response

ok

idstring uuid required
provider'gohighlevel' | 'hubspot' | 'activecampaign' | 'salesforce' | 'pipedrive' required
status'connected' | 'needs_auth' | 'paused' | 'disabled' required
settingsobject required

Opaque JSON object

healthStatusstring required
lastHealthCheckAtstring nullable required
connectedAtstring required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.