crm

Create Connection

Register a partner CRM connection.

Two shapes, chosen by credential_kind:

  • oauth (Lawmatics): store the partner's app credentials and mint the authorize_url they click (while logged in to their CRM) to grant access; the callback endpoint below finishes the handshake.
  • api_key (Instantly): store the partner's pasted scoped key (encrypted) and go straight to connected — no app to create, no callback. The partner's only action is pasting the key.
post/api/v1/crm/connections

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/crm/connections
  • Auth: API key in header X-API-Key

Request body

labelstring required
providerstring
credential_kindstring
client_idstring nullable
client_secretstring nullable
redirect_uristring nullable
api_keystring nullable
campaign_idstring nullable

Response

Successful Response

connection_idstring required
providerstring required
labelstring required
statusstring required
credential_kindstring required
redirect_uristring nullable
authorize_urlstring nullable
connected_atstring date-time nullable

Changes

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