Шаблоны писем

API 0.16.0OpenAPIllms-full.txt

PUT/v1/mailboxes/{mailbox_id}/templates/{template_id}

До 100 шаблонов на ящик. Поля name, subject, text и html; HTML очищается. Шаблон не отправляет письмо сам.

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

Запрос

curl -X PUT 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/templates/<template_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  --data '{"name":"<name>"}'

Параметры

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

integer

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

integer

X-Customer-IDheader

Вариант 1

string

Вариант 2

null

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

object

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

string

minLength: 1

maxLength: 120

subject

string

По умолчанию: ""

maxLength: 998

text

string

По умолчанию: ""

maxLength: 20000

html

string

По умолчанию: ""

maxLength: 30000

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

Ответы

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

application/json

object

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

integer

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

object

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

string

minLength: 1

maxLength: 120

subject

string

По умолчанию: ""

maxLength: 998

text

string

По умолчанию: ""

maxLength: 20000

html

string

По умолчанию: ""

maxLength: 30000

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

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

string

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

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