createFolder

Создаёт папку в ящике. Название передают как есть, кириллицей тоже: Gratio сам переведёт его в кодировку IMAP. Папку сразу видно в почтовых программах.

Параметры

Пример запроса

Папка «Заявки» в корне ящика:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/createFolder/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name": "Заявки"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/createFolder/{TOKEN}"
payload = {"name": "Заявки"}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/createFolder/${GRATIO_TOKEN}`;
const payload = { name: "Заявки" };
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/createFolder/' . getenv('GRATIO_TOKEN');
$payload = ['name' => 'Заявки'];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK:

{"folder": "&BBcEMARPBDIEOgQ4-", "title": "Заявки"}

Поля ответа

Ещё примеры

Внутри архива

Папка внутри «Архива». Имя на сервере — с разделителем папок этого сервера:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/createFolder/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name": "Заявки", "parent": "archive"}'

Ответ 200 OK:

{"folder": "Archive/&BBcEMARPBDIEOgQ4-", "title": "Заявки"}

Ошибки

Общие правила — в статье Ответы и ошибки.

Что дальше

• moveMessages — перенести письма в новую папку.
• renameFolder — переименовать папку.
• Настройки ящика — получать уведомления о письмах в этой папке (emailFolders).