Umbenennen

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

Legt den Kampagnennamen einer zuvor erstellten Nachricht fest oder löscht ihn; die Nachricht wird durch ihren message_code identifiziert. Alles andere an der Nachricht bleibt unverändert. Inhalt, Zielgruppe und Zeitplan bleiben genau so, wie sie waren.

Umbenennen ist nur möglich, solange sich die Nachricht im Zustand ausstehend befindet – erstellt, aber noch nicht zum Senden abgeholt. Eine Nachricht, die in den Zustand waiting, processing oder einen späteren Zustand übergegangen ist, kann nicht mehr umbenannt werden. Im Control Panel wird dieser Zustand in der Spalte Status als Geplant angezeigt, nicht wörtlich als „Pending”. Siehe Nachrichtenstatus.

Um zu überprüfen, ob eine Nachricht noch in einem umbenennbaren Zustand ist, siehe Nachrichtenstatus prüfen.

Anfrage

Authentifizieren Sie sich mit Ihrem Server API-Token im Authorization: Token <API_TOKEN>-Header.

Feld	Typ	Erforderlich	Beschreibung
`message_code`	string	Ja	Nachrichtencode der umzubenennenden Nachricht, wie von `Notify` in `result.message_code` zurückgegeben.
`campaign_name`	string	Ja	Neuer Kampagnenname. Wird bereinigt und auf 255 Zeichen gekürzt. Ein leerer String löscht den Namen.

Beispielanfrage

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"
  }'

Antwort

Bei Erfolg wird HTTP 200 mit einem leeren JSON-Body zurückgegeben.

{}

Fehler

Fehler verwenden den standardmäßigen gRPC-Gateway-Fehlerumschlag: { "code": ..., "message": ..., "details": [...] }.

HTTP-Status	Bedingung
`400`	`message_code` fehlt.
`400`	Die Nachricht befindet sich nicht in einem umbenennbaren Zustand (sie ist nicht mehr `pending`).
`403`	Die Nachricht gehört zu einem anderen Konto.
`404`	Für den angegebenen `message_code` existiert keine Nachricht.
`500`	Beim Laden der Nachricht oder Anwenden des neuen Namens ist ein interner Fehler aufgetreten. Versuchen Sie die Anfrage erneut.

Beispiel

Das Umbenennen einer Nachricht, deren Versand bereits begonnen hat, gibt HTTP 400 zurück:

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

Nachrichtenstatus prüfen

Vor dem Umbenennen können Sie überprüfen, ob sich eine Nachricht noch in einem umbenennbaren Zustand befindet. Neben dem Lesen der Spalte Status in der Nachrichtentabelle im Control Panel (Kampagnen → Einmalige Nachrichten), wo eine umbenennbare Nachricht als Geplant angezeigt wird und nicht wörtlich als „Pending”, können Sie den Status auch programmatisch mit messages:list abfragen:

Übergeben Sie den message_code im filters.messages_codes-Array (zusammen mit dem erforderlichen filters.application).
Lesen Sie das status-Feld des passenden Eintrags in items[].