Перейти к содержимому
adaptmailAPI
Русский

Настройки почтового ящика

API 0.16.0OpenAPIllms-full.txt
PATCH/v1/mailboxes/{mailbox_id}

Через /v1 можно менять name, password и signature. Общая квота quota_mb меняется через панель хостинга. Отдельной квоты для файлов нет. Idempotency-Key необязателен, но рекомендуется для повторов.

Авторизация и области доступа · Ошибки и повторы

Запрос

Окно терминала
curl -X PATCH 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Support","signature":"Support team"}'

Параметры

mailbox_idpathОбязательно

integer

X-Customer-IDheader
Вариант 1

string

Вариант 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

Тело запроса · application/json

object

name
Вариант 1

string

minLength: 1

maxLength: 120

Вариант 2

null

quota_mb
Вариант 1

integer

minimum: 10240

Вариант 2

null

file_quota_mb
Вариант 1

integer

minimum: 256

maximum: 512000

Вариант 2

null

password
Вариант 1

string

minLength: 12

maxLength: 128

Вариант 2

null

signature
Вариант 1

string

maxLength: 5000

Вариант 2

null

Неизвестные поля не принимаются.

Ответы

202 Успешный ответ

application/json

object

id

string · uuid

Идентификатор операции для проверки состояния и отмены ожидающей отправки.

kind

string

mailbox_id
Вариант 1

integer

Вариант 2

null

status

string

Допустимые значения: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

created_at

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

completed_at
Вариант 1

string

Дата и время в UTC. Если смещение отсутствует, значение также представляет UTC.

Вариант 2

null

error

Причина ошибки, если операция не завершилась успешно.

Вариант 1

string

Вариант 2

null

result

Результат выполнения операции. Для отправки содержит сведения о принятых и отклонённых получателях.

Вариант 1

object

Вариант 2

null

400 Некорректный заголовок или идентификатор

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

401 Требуется вход

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Нет доступа

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ресурс не найден

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

409 Конфликт состояния

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка валидации

application/json

object

detail

array

Элементы массива

object

locОбязательно

array

Элементы массива
Вариант 1

string

Вариант 2

integer

msgОбязательно

string

typeОбязательно

string

503 Временная недоступность

application/json

object

detail
Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object