Update campaign · Coldy API

PATCH /campaigns/{id}

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Path parameters

id string required

UUID of the campaign which you want to patch

Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/json

name string

Campaign name.

Example: Warmup January Campaign

prioritize_new_leads boolean

If enabled — system prioritizes sending to new leads first.

Example: true

open_tracking boolean

Enable or disable email open tracking.

Example: true

stop_on_reply boolean

If true — campaign stops automatically when any lead replies.

Example: false

schedule any

Embedded schedule update object.

account_ids number[]

Array of account IDs (email senders) that campaign should use.

Example: [10, 14, 22]

Response

application/json

Campaign successfully updated

status string required

Status of action

Example: success

Request

curl --request PATCH \
  --url https://developer.coldy.ai/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Warmup January Campaign",
  "prioritize_new_leads": true,
  "open_tracking": true,
  "stop_on_reply": false,
  "schedule": "string",
  "account_ids": [
    10,
    14,
    22
  ]
}'

{
  "result": "success"
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}