Create campaign · Coldy API

POST /campaigns

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Body

application/json

Campaign data

name string required

Name of the campaign

Example: Black Friday Campaign

Response

application/json

Campaign created successfully

id string required

Example: 8f3c2c91-4f8d-4e65-8c9f-4e9b12345678

index number required

Index

Example: 1

name string required

Name of campaign

Example: Black Friday Campaign

sending_priority string required

Sending priority

Example: sequence_emails

user_id number required

ID of user who owns campaign

Example: 42

replies_emails number required

Number of emails with replies

Example: 3

opened_emails number required

Number of emails opened

Example: 15

id_previous_getting_lead number required

ID of previous lead

Example: 1001

wait_schedule boolean required

Whether wait schedule is active

Example: false

is_message_plain_text boolean required

Use plain text messages

Example: false

is_open_tracking_disabled boolean required

Open tracking disabled

Example: false

is_stop_sending_on_reply boolean required

Stop sending on reply

Example: true

is_stop_sending_on_company_reply boolean required

Stop sending on company reply

Example: false

status string required

Status of campaign

Example: Draft

Request

curl --request POST \
  --url https://developer.coldy.ai/api/v1/campaigns \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Black Friday Campaign"
}'

{
  "id": "8f3c2c91-4f8d-4e65-8c9f-4e9b12345678",
  "index": 1,
  "name": "Black Friday Campaign",
  "sending_priority": "sequence_emails",
  "user_id": 42,
  "replies_emails": 3,
  "opened_emails": 15,
  "id_previous_getting_lead": 1001,
  "wait_schedule": false,
  "is_message_plain_text": false,
  "is_open_tracking_disabled": false,
  "is_stop_sending_on_reply": true,
  "is_stop_sending_on_company_reply": false,
  "status": "Draft"
}

{
  "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"
}