Редактирование шаблона

PATCH

/v1/wa/apps/{appId}/templates/{tplId}

Данный эндпоинт API предназначен для редактирования шаблона сообщения. После редактирования, шаблон отправиться на модерацию в WhatsApp для утверждения. Утвержденные шаблоны могут быть использованы для отправки сообщений пользователям.

TIP

Редактировать шаблоны можно только со статусом APPROVED, REJECTED и PAUSED.

Авторизация

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры

Важно

Если поля category, header, footer и buttons не переданы, их значения будут взяты из текущего состояния шаблона.

Для удаления header, footer или buttons необходимо передать пустое значение:

{
  "header": '',
  "footer": '',
  "buttons": [] | null
}

Параметр	Расположение	Тип	Описание	Ограничения
appId	Path	string	Уникальный идентификатор приложения.
tplId	Path	string	Уникальный идентификатор шаблона.
category	Body	string Необязательный	Категория шаблона.	Возможные значения: MARKETING UTILITY SERVICE. Подробнее о шаблонах в разделе: категории шаблонов
header	Body	string Необязательный	Заголовок шаблона (верхняя часть).	Максимальное количество символов: 60
header_example	Body	string Необязательный. Обязателен, если заполнено поле header	Пример заголовка шаблона.
body	Body	string	Тело шаблона.	Максимальное количество символов: 550
body_example	Body	string Необязательный. Обязателен, если заполнено поле body	Пример тела шаблона.
footer	Body	string Необязательный	Подвал шаблона.	Максимальное количество символов: 60
buttons	Body	Array of objects Необязательный	Кнопки шаблона.	Минимальное количество кнопок: 1. Максимальное количество кнопок: 10. Допустимые типы кнопок: QUICK_REPLY, URL.

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

Простой запрос на редактирование текстового шаблона:

curl -X PATCH \
  https://space.getloo.ru/api/v1/wa/apps/{appId}/templates/{tplId} \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "category": "MARKETING", "header": "Welcome", "header_example": "Welcome", "body": "Hello, John!", "body_example": "Hello, John!", }'

{
  "category": "MARKETING",
  "header": "Welcome",
  "header_example": "Welcome",
  "body": "Hello, John!",
  "body_example": "Hello, John!"
}

Запрос на редактирование текстового шаблона с кнопками и переменными:

curl -X PATCH \
  https://space.getloo.ru/api/v1/wa/apps/{appId}/templates/{tplId} \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "category": "MARKETING", "header": "Welcome back, {{1}}!", "header_example": "Welcome back, John!", "body": "Hello, {{1}}!", "body_example": "Hello, John!", "buttons": [ { "type": "QUICK_REPLY", "text": "Yes" }, { "type": "URL", "text": "My Awesome Site", "url": "https://example.com/{{1}}", "example": "https://example.com/about" } ] }'

{
  "name": "Example Template",
  "language": "ru",
  "header": "Welcome back, {{1}}!",
  "header_example": "Welcome back, John!",
  "body": "Hello, {{1}}!",
  "body_example": "Hello, John!",
  "category": "MARKETING",
  "type": "TEXT",
  "buttons": [
    {
      "type": "QUICK_REPLY",
      "text": "Yes"
    },
    {
      "type": "URL",
      "text": "My Awesome Site",
      "url": "https://example.com/{{1}}",
      "example": "https://example.com/about"
    }
  ]
}

Коды состояния

Код состояния	Описание
204	Запрос успешно выполнен
400	Некорректный запрос (ошибка при валидации)
401	Неавторизованный запрос
403	Доступ запрещён
422	Невозможно обработать запрос. Система вернёт ошибку, если статус шаблона отличается от : APPROVED, REJECTED или PAUSED,
404	Не найдено