Trigger a CRM lead import into a campaign

POST /campaigns/{id}/import-from-crm

Trigger a CRM lead import into a campaign

cURL

curl --request POST \
  --url https://api.pineyard.ai/campaigns/{id}/import-from-crm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionId": "<string>"
}
'

200

{
  "import": {
    "id": "<string>",
    "status": "PENDING",
    "fetched": 123,
    "added": 123,
    "skipped": 123,
    "startedAt": "<string>",
    "finishedAt": "<string>",
    "errors": null
  }
}

Required scope: crm.edit, and API keys additionally need campaigns.edit.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Body

application/json

connectionId · string · required

Minimum string length: 1

segmentId · string

since · string

Response

200

application/json

OK

import · object · required

Show child attributes