Create a CRM connection

Connects a CRM to your account using an OAuth credential you have already stored. The connection is created active with syncing enabled, but nothing is pulled in until you call POST /api/v1/crm/sync. Only one connection may exist per CRM and organization; a duplicate answers 409.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The CRM to connect: zoho_billing, zoho_crm, zoho_books, hubspot, salesforce, pipedrive or freshsales; a value that has no registered connector is rejected with 400.

string
required

ID of the stored OAuth credential the connector authenticates with.

string

Display name for the connection; defaults to <crm_source> Connection.

string

The CRM-side organization or account ID, for providers that scope data by one.

config
object

Free-form connector configuration; defaults to {}.

Responses
201

The connection was created, active and with syncing enabled.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json