Re-engage cold leads

Re-engage the campaign’s already-completed cold leads now (re-opens a finished campaign)

POST /campaigns/{id}/reengage

Re-engage cold leads

cURL

curl --request POST \
  --url https://api.pineyard.ai/campaigns/{id}/reengage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{}'

200

{
  "swept": 123,
  "churnEnabled": true,
  "willDial": true
}

Required scope: campaigns.edit

Idempotency: an Idempotency-Key header is required when calling with an API key. See Idempotency.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Headers

Idempotency-Key · string · required

Unique value (e.g. a UUID) per action, up to 200 printable ASCII characters. Reuse it only to retry the same request; the first response is replayed for 24 hours.

Maximum string length: 200

Example:

"f1d2c3b4-0000-4000-8000-000000000000"

Path Parameters

id · string · required

Body

application/json

churnMaxAttempts · integer

Required range: 1 <= x <= 10

churnIntervalHours · integer

Required range: 1 <= x <= 720

window · object

Show child attributes

Response

200

application/json

OK

swept · number · required

churnEnabled · boolean · required

willDial · boolean · required