Создать аккаунт

POST /accounts

Аутентификация

Передавайте API-ключ организации как Bearer-токен.

Authorization: Bearer YOUR_API_KEY

Тело запроса

application/json

Данные учетной записи, необходимые для создания новой email-аккаунта.

first_name string обязательное

Имя владельца аккаунта

Пример: John

last_name string обязательное

Фамилия владельца аккаунта

Пример: Doe

email string обязательное

Адрес email аккаунта

Пример: john.doe@example.com

imap_password string обязательное

IMAP пароль для email-аккаунта

Пример: imap-secret-password

smtp_password string обязательное

SMTP пароль для email-аккаунта

Пример: smtp-secret-password

smtp_host string обязательное

Хост SMTP (например, smtp.gmail.com)

Пример: smtp.gmail.com

smtp_port number обязательное

Порт SMTP (по умолчанию: 465)

Пример: 465

imap_host string обязательное

Хост IMAP (например, imap.gmail.com)

Пример: imap.gmail.com

imap_port number обязательное

Порт IMAP (по умолчанию: 993)

Пример: 993

cooldown_start number

Период начала восстановления в секундах (по умолчанию: 180)

Пример: 180

cooldown_end number

Период окончания перезарядки в секундах (по умолчанию: 360)

Пример: 360

signature string

Текст подписи email

Пример: Best regards, John Doe

daily_limit number

Дневной лимит отправки (по умолчанию: 50)

Пример: 50

warmup any

Объект конфигурации прогрева

Пример: {"enable":false,"limit":20,"start":1}

provider_code number обязательное

Код провайдера email (1=Google, 2=Яндекс, 3=Mailru/VK, 4=Пользовательский IMAP/SMTP)

Допустимые значения: 1, 2, 3, 4

Пример: 4

Ответ

application/json

Аккаунт успешно создан

id number обязательное

ID аккаунта

Пример: 1

email string обязательное

Электронная почта аккаунта

Пример: user@example.com

first_name string обязательное

Имя

Пример: John

last_name string обязательное

Фамилия

Пример: Doe

warmup boolean обязательное

Включен ли прогрев

Пример: true

warmup_last_date_send string обязательное

Последняя дата, когда разминка отправила email-сообщение

Пример: 2025-09-20T12:00:00.000Z

last_type_send_email string обязательное

Тип последнего отправленного письма

Пример: warmup

warmup_start_date string обязательное

Дата начала разминки

Пример: 2025-09-10T10:00:00.000Z

warmup_sent_today number обязательное

Количество разогревающих писем, отправленных сегодня

Пример: 5

warmup_daily_limit number обязательное

Дневной лимит разминки

Пример: 20

warmup_starting_email_number number обязательное

Начальный номер email для разминки

Пример: 1

expected_to_send_warmup_emails number обязательное

Ожидается отправка разминочных писем

Пример: 50

service string обязательное

Сервис (google, yandex и т.д.)

Пример: google

limit number обязательное

Лимит отправки в день

Пример: 50

sent_today number обязательное

Отправлено сегодня

Пример: 10

total_sent number обязательное

Всего отправленных писем

Пример: 300

id_previous_sending_campaign number обязательное

ID предыдущей рассылки отправки

Пример: 123

cooldown_start number обязательное

Начало перезарядки (секунды)

Пример: 180

cooldown_end number обязательное

Окончание перезарядки (секунды)

Пример: 360

is_account_ready string обязательное

Дата готовности аккаунта

Пример: 2025-09-18T09:00:00.000Z

user_id number обязательное

Пользователь ID, владеющий учетной записью

Пример: 42

tags string[] обязательное

Теги, присвоенные аккаунту

Пример: ["Disconnected", "Bounce"]

last_block_account_date string обязательное

Дата последней блокировки аккаунта

Пример: 2025-09-21T14:00:00.000Z

error_text string обязательное

Текст ошибки, если учетная запись не удалось подключиться

Пример: Invalid credentials

signature string обязательное

Подпись, прикрепленная к исходящим электронным письмам

Пример: Best regards, John

Запрос

curl --request POST \
  --url https://developer.coldy.ai/api/v1/accounts \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "imap_password": "password123",
  "smtp_password": "password123",
  "smtp_host": "smtp.example.com",
  "smtp_port": 465,
  "imap_host": "imap.example.com",
  "imap_port": 993,
  "cooldown_start": 180,
  "cooldown_end": 360,
  "signature": "Best regards, John",
  "daily_limit": 50,
  "warmup": {
    "enable": false,
    "limit": 20,
    "start": 1
  },
  "provider_code": 4
}'

{
  "item": {
    "id": 1,
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "warmup": true,
    "warmup_last_date_send": "2025-09-20T12:00:00.000Z",
    "last_type_send_email": "warmup",
    "warmup_start_date": "2025-09-10T10:00:00.000Z",
    "warmup_sent_today": 5,
    "warmup_daily_limit": 20,
    "warmup_starting_email_number": 1,
    "expected_to_send_warmup_emails": 50,
    "service": "google",
    "limit": 50,
    "sent_today": 10,
    "total_sent": 300,
    "id_previous_sending_campaign": 123,
    "cooldown_start": 180,
    "cooldown_end": 360,
    "is_account_ready": "2025-09-18T09:00:00.000Z",
    "user_id": 42,
    "tags": [],
    "last_block_account_date": "2025-09-21T14:00:00.000Z",
    "error_text": "Invalid credentials",
    "signature": "Best regards, John"
  }
}

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