Edit campaign settings

PATCHhttps://server.heyrik.com/api/v1/campaigns/{id}

Path parameters

idRequired

Replace {id} in the request URL with the value for this resource.

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 10

Fields documented for this operation. See the request example for placement and structure.

namestring

Rename the campaign.

max_retriesnumber

How many times to re-dial a lead that didn't connect.

retry_delay_secnumber

Seconds to wait before a retry.

schedule_atstring

ISO time to start automatically (null to clear).

call_window_start / call_window_endstring

"HH:MM" 24h — only dial within this daily window (in `timezone`).

call_daysnumber[]

Days to dial, 0=Sun…6=Sat. null/[] = every day.

timezonestring

IANA tz for the window, e.g. "Asia/Kolkata".

extraction_schemaobject[]

Per-campaign fields to extract on every call: [{ name, description }].

classifyobject

Auto-tag each call into a bucket: { field, buckets: [{ label, description }] } — lands on each contact's category.

webhook_urlstring

POST each finished call to this URL.

Response

No response example is documented for this operation yet.

Error reference

PATCH/campaigns/{id}

cURL

curl -X PATCH https://server.heyrik.com/api/v1/campaigns/cmp_4a19 \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "max_retries": 2,
    "retry_delay_sec": 600,
    "call_window_start": "10:00",
    "call_window_end": "18:00",
    "call_days": [1, 2, 3, 4, 5],
    "timezone": "Asia/Kolkata",
    "classify": { "field": "lead_category", "buckets": [
      { "label": "hot", "description": "ready to buy" },
      { "label": "cold", "description": "not interested" }
    ] }
  }'

Illustrative examples · No live request is sent