Connect a CRM via API key (e.g. LeadSquared)

POST /crm/{slug}/connect

Connect a CRM via API key (e.g. LeadSquared)

cURL

curl --request POST \
  --url https://api.pineyard.ai/crm/{slug}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "credentials": {}
}
'

200

{
  "connection": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "status": "ACTIVE",
    "providerEmail": "<string>",
    "connectedAt": "<string>",
    "display": {},
    "hasWebhookSecret": true,
    "webhookUrl": "<string>",
    "deferredEventCount": 1,
    "missingScopes": [
      "<string>"
    ],
    "webhookTopics": {
      "subscribed": [
        "<string>"
      ],
      "failed": [
        {
          "topic": "<string>",
          "reason": "<string>"
        }
      ],
      "checkedAt": "<string>"
    }
  }
}

Required scope: crm.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

slug · string · required

Body

application/json

name · string · required

Required string length: 1 - 120

credentials · object · required

Show child attributes

Response

200

application/json

OK

connection · object · required

Show child attributes