Live-edit a campaign’s pacing/schedule (allowed while RUNNING)

PATCH /campaigns/{id}/schedule

Live-edit a campaign’s pacing/schedule (allowed while RUNNING)

cURL

curl --request PATCH \
  --url https://api.pineyard.ai/campaigns/{id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dailyDialCap": 50000,
  "dialDays": [
    3
  ],
  "timezone": "<string>",
  "scheduledStartAt": "2023-11-07T05:31:56Z",
  "scheduledEndAt": "2023-11-07T05:31:56Z",
  "dailyWindowStart": "<string>",
  "dailyWindowEnd": "<string>",
  "retryCount": 5,
  "cooldownMinutes": 21602,
  "retryDelaysMinutes": [
    21600
  ],
  "churnEnabled": true,
  "churnMaxAttempts": 5,
  "churnIntervalHours": 1080,
  "churnDelaysHours": [
    1080
  ],
  "goal": "<string>",
  "briefText": "<string>",
  "briefFileName": "<string>",
  "incompleteRetryEnabled": true,
  "incompleteRetryMaxAttempts": 3,
  "incompleteRetryIntervalMinutes": 720,
  "incompleteRetryDelaysMinutes": [
    720
  ],
  "incompleteCallSeconds": 152,
  "referralMaxDepth": 1,
  "skipRetryOnFirstVoicemail": true,
  "messageRetryEnabled": true,
  "messageRetryMaxAttempts": 5,
  "messageRetryIntervalSeconds": 302400,
  "messageRetryDelaysSeconds": [
    302400
  ],
  "messageRetryWindowSeconds": 1296000,
  "messageRetryTieredEnabled": true,
  "messageRetryTransientMaxAttempts": 50,
  "autoReseedEnabled": true,
  "retryConcurrencyPercent": 50
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "agentId": "<string>",
  "agentName": "<string>",
  "channel": "VOICE",
  "status": "<string>",
  "reservedConcurrency": 123,
  "variableMap": {},
  "startedAt": "<string>",
  "endedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "campaignTypeId": "<string>",
  "campaignTypeName": "<string>",
  "customExtractionKeys": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>"
    }
  ],
  "effectiveExtractionKeys": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>"
    }
  ],
  "notificationUserIds": [
    "<string>"
  ],
  "source": "CSV",
  "defaultCrmConnectionId": "<string>",
  "defaultCrmSegmentId": "<string>",
  "description": "<string>",
  "whatsappOutreachTemplateId": "<string>",
  "whatsappTemplateByMetric": null,
  "messageDeclinedLeads": true,
  "dailyMessageCap": 123,
  "outreachRules": [
    {
      "trigger": "MESSAGE_REPLY",
      "afterDays": 45,
      "condition": {
        "kind": "ai_interested",
        "describe": "<string>"
      },
      "conditions": [
        {
          "kind": "ai_interested",
          "describe": "<string>"
        }
      ],
      "match": "ALL",
      "action": "HAND_OFF"
    }
  ],
  "whatsappEnabled": true,
  "whatsappAgentTemplateIds": [
    "<string>"
  ],
  "whatsappPaymentLinkEnabled": true,
  "recoveryLinkEnabled": true,
  "whatsappAutomations": [
    {
      "key": "<string>",
      "label": "<string>",
      "detail": "<string>"
    }
  ],
  "workflowId": "<string>",
  "countryCode": "<string>",
  "phoneColumn": "<string>",
  "altPhoneColumns": [
    "<string>"
  ],
  "removeInvalidRows": true,
  "transliterateCalleeNames": true,
  "uploadId": "<string>",
  "timezone": "<string>",
  "scheduledStartAt": "<string>",
  "scheduledEndAt": "<string>",
  "dailyWindowStart": "<string>",
  "dailyWindowEnd": "<string>",
  "retryCount": 123,
  "cooldownMinutes": 123,
  "retryDelaysMinutes": [
    123
  ],
  "retryConcurrencyPercent": 123,
  "followupEnabled": true,
  "followupMaxAttempts": 123,
  "churnEnabled": true,
  "churnMaxAttempts": 123,
  "churnIntervalHours": 123,
  "churnDelaysHours": [
    123
  ],
  "goal": "<string>",
  "incompleteRetryEnabled": true,
  "incompleteRetryMaxAttempts": 123,
  "incompleteRetryIntervalMinutes": 123,
  "incompleteRetryDelaysMinutes": [
    123
  ],
  "incompleteCallSeconds": 123,
  "referralMaxDepth": 123,
  "skipRetryOnFirstVoicemail": true,
  "messageRetryEnabled": true,
  "messageRetryMaxAttempts": 123,
  "messageRetryIntervalSeconds": 123,
  "messageRetryDelaysSeconds": [
    123
  ],
  "messageRetryWindowSeconds": 123,
  "messageRetryTieredEnabled": true,
  "messageRetryTransientMaxAttempts": 123,
  "autoReseedEnabled": true,
  "briefFileName": "<string>",
  "briefUploadedAt": "<string>",
  "briefText": "<string>",
  "dailyDialCap": 123,
  "dialDays": [
    123
  ],
  "evaluationMetrics": [
    {
      "key": "<string>",
      "label": "<string>",
      "allowedValues": [
        "<string>"
      ],
      "prompt": "<string>",
      "builtin": true
    }
  ],
  "contactCount": 123,
  "receivedCalls": 123
}

Required scope: campaigns.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Body

application/json

dailyDialCap · integer | null

Required range: 1 <= x <= 100000

dialDays · integer[]

Required array length: 1 - 7 elements

Required range: 0 <= x <= 6

timezone · string

scheduledStartAt · string<date-time>

scheduledEndAt · string<date-time> | null

dailyWindowStart · string

Pattern: ^\d{2}:\d{2}$

dailyWindowEnd · string

Pattern: ^\d{2}:\d{2}$

retryCount · integer

Required range: 0 <= x <= 10

cooldownMinutes · integer

Required range: 5 <= x <= 43200

retryDelaysMinutes · integer[]

Maximum array length: 10

Required range: 1 <= x <= 43200

churnEnabled · boolean

churnMaxAttempts · integer

Required range: 1 <= x <= 10

churnIntervalHours · integer

Required range: 1 <= x <= 2160

churnDelaysHours · integer[]

Maximum array length: 10

Required range: 1 <= x <= 2160

goal · string | null

Maximum string length: 500

briefText · string | null

Maximum string length: 200000

briefFileName · string | null

Maximum string length: 255

incompleteRetryEnabled · boolean

incompleteRetryMaxAttempts · integer

Required range: 1 <= x <= 5

incompleteRetryIntervalMinutes · integer

Required range: 1 <= x <= 1440

incompleteRetryDelaysMinutes · integer[]

Maximum array length: 5

Required range: 1 <= x <= 1440

incompleteCallSeconds · integer

Required range: 5 <= x <= 300

referralMaxDepth · integer

Required range: 0 <= x <= 3

skipRetryOnFirstVoicemail · boolean

messageRetryEnabled · boolean

messageRetryMaxAttempts · integer

Required range: 1 <= x <= 10

messageRetryIntervalSeconds · integer

Required range: 1 <= x <= 604800

messageRetryDelaysSeconds · integer[]

Maximum array length: 10

Required range: 1 <= x <= 604800

messageRetryWindowSeconds · integer

Required range: 1 <= x <= 2592000

messageRetryTieredEnabled · boolean

messageRetryTransientMaxAttempts · integer

Required range: 1 <= x <= 100

autoReseedEnabled · boolean

retryConcurrencyPercent · integer | null

Required range: 0 <= x <= 100

Response

200

application/json

OK

id · string · required

name · string · required

agentId · string | null · required

agentName · string | null · required

channel · enum<string> · required

Available options: VOICE, WHATSAPP, VOICE_THEN_WHATSAPP, WHATSAPP_THEN_VOICE, CUSTOM, EMAIL

status · string · required

reservedConcurrency · number · required

variableMap · object · required

Show child attributes

startedAt · string | null · required

endedAt · string | null · required

createdAt · string · required

updatedAt · string · required

campaignTypeId · string | null · required

campaignTypeName · string | null · required

customExtractionKeys · object[] · required

Show child attributes

effectiveExtractionKeys · object[] · required

Show child attributes

notificationUserIds · string[] · required

source · enum<string> · required

Available options: CSV, CRM_MANUAL, CRM_WEBHOOK, API, INBOUND

defaultCrmConnectionId · string | null · required

defaultCrmSegmentId · string | null · required

description · string | null

whatsappOutreachTemplateId · string | null

whatsappTemplateByMetric · unknown

messageDeclinedLeads · boolean

dailyMessageCap · number | null

outreachRules · object[] | null

Maximum array length: 20

Show child attributes

whatsappEnabled · boolean

whatsappAgentTemplateIds · string[]

whatsappPaymentLinkEnabled · boolean

recoveryLinkEnabled · boolean

whatsappAutomations · object[]

Show child attributes

workflowId · string | null

countryCode · string | null

phoneColumn · string | null

altPhoneColumns · string[]

removeInvalidRows · boolean

transliterateCalleeNames · boolean

uploadId · string | null

timezone · string | null

scheduledStartAt · string | null

scheduledEndAt · string | null

dailyWindowStart · string | null

dailyWindowEnd · string | null

retryCount · number

cooldownMinutes · number

retryDelaysMinutes · number[]

retryConcurrencyPercent · number | null

followupEnabled · boolean

followupMaxAttempts · number

churnEnabled · boolean

churnMaxAttempts · number

churnIntervalHours · number

churnDelaysHours · number[]

goal · string | null

incompleteRetryEnabled · boolean

incompleteRetryMaxAttempts · number

incompleteRetryIntervalMinutes · number

incompleteRetryDelaysMinutes · number[]

incompleteCallSeconds · number

referralMaxDepth · number

skipRetryOnFirstVoicemail · boolean

messageRetryEnabled · boolean

messageRetryMaxAttempts · number

messageRetryIntervalSeconds · number

messageRetryDelaysSeconds · number[]

messageRetryWindowSeconds · number

messageRetryTieredEnabled · boolean

messageRetryTransientMaxAttempts · number

autoReseedEnabled · boolean

briefFileName · string | null

briefUploadedAt · string | null

briefText · string | null

dailyDialCap · number | null

dialDays · number[]

evaluationMetrics · object[]

Maximum array length: 12

Show child attributes

contactCount · number

receivedCalls · number