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

POST https://api.pushwoosh.com/messaging/v2/rename

Устанавливает или очищает название кампании ранее созданного сообщения, идентифицированного по его message_code. Больше ничего в сообщении не меняется. Содержимое, аудитория и расписание остаются в точности такими же, как были.

Переименование доступно только пока сообщение находится в состоянии ожидания (pending) — то есть создано, но еще не взято в обработку для отправки. Сообщение, перешедшее в состояние waiting, processing или любое более позднее, переименовать уже нельзя. В Control Panel это состояние отображается в столбце Статус как Запланировано, а не буквально «Pending». См. Статусы сообщений.

Название обрезается по начальным и конечным пробелам и ограничивается 255 символами. Пустое название (или состоящее только из пробелов) полностью очищает название кампании, и сообщение возвращается к своему заголовку по умолчанию в Message History.
Этот вызов идемпотентен: повторная отправка того же названия повторно применяет то же значение. При этом время последнего изменения сообщения обновляется при каждом вызове, независимо от того, изменилось ли название на самом деле, поэтому повторный вызов может переместить сообщение наверх сортировки Message History по умолчанию — По дате изменения.

Чтобы проверить, находится ли сообщение все еще в состоянии, допускающем переименование, см. Проверка статуса сообщения.

Запрос

Аутентифицируйтесь с помощью вашего Server API token в заголовке Authorization: Token <API_TOKEN>.

Поле	Тип	Обязательно	Описание
`message_code`	string	Да	Код сообщения, которое нужно переименовать, возвращаемый методом `Notify` в `result.message_code`.
`campaign_name`	string	Да	Новое название кампании. Обрезается по пробелам и ограничивается 255 символами. Пустая строка очищает название.

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

curl -X POST https://api.pushwoosh.com/messaging/v2/rename \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX",
    "campaign_name": "Flash_Sale_Push"
  }'

Ответ

В случае успеха возвращает HTTP 200 с пустым телом JSON.

{}

Ошибки

Ошибки используют стандартную оболочку ошибок gRPC-Gateway: { "code": ..., "message": ..., "details": [...] }.

HTTP-статус	Условие
`400`	Отсутствует `message_code`.
`400`	Сообщение не находится в состоянии, допускающем переименование (оно больше не в состоянии `pending`).
`403`	Сообщение принадлежит другому аккаунту.
`404`	Сообщение с указанным `message_code` не существует.
`500`	Произошла внутренняя ошибка при загрузке сообщения или применении нового названия. Повторите запрос.

Пример

Переименование сообщения, отправка которого уже началась, вернет HTTP 400:

{
  "code": 9,
  "message": "message status \"waiting\" is not renamable",
  "details": []
}

Проверка статуса сообщения

Перед переименованием вы можете проверить, находится ли сообщение все еще в состоянии, допускающем переименование. Помимо просмотра столбца Статус в таблице сообщений в Control Panel (Кампании → Разовые сообщения), где сообщение, допускающее переименование, отображается как Запланировано, а не буквально «Pending», вы можете запросить статус программно с помощью messages:list:

Передайте message_code в массиве filters.messages_codes (вместе с обязательным filters.application).
Прочитайте поле status соответствующей записи в items[].

Связанные материалы

Notify

Update

Cancel

Статистика сообщений

Обзор Messaging API v2

Миграция с v1