Vorlagenkonfiguration löschen

Löschen Sie die angegebene Vorlagenkonfiguration. Wenn die Vorlage derzeit von einem Nachrichtenplan verwendet wird (im Status „ausstehend" oder „laufend"), kann sie nicht gelöscht werden.

Anfrage-URL

DELETE https://smsapi.engagelab.com/v1/template-configs/:templateId

Aufruf-Authentifizierung

Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.

Anfragebeispiel

Anfrage-Header

DELETE /v1/template-configs/123456789 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              DELETE /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

Keiner

Anfrageparameter

Pfadparameter

Parameter	Typ	Option	Beschreibung
templateId	String	Erforderlich	Vorlagen-ID

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext enthält die folgenden Felder:

Feld	Typ	Beschreibung
code	Integer	Statuscode, 0 bedeutet Erfolg
message	String	Statusbeschreibung

Erfolgsbeispiel

{ "code": 0, "message": "success" }

              
              {
  "code": 0,
  "message": "success"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

Der HTTP-Statuscode ist 4xx/5xx, und der Antworttext enthält die folgenden Felder:

Feld	Typ	Beschreibung
code	Integer	Fehlercode
message	String	Fehlerdetails

Fehlerbeispiel

{ "code": 400, "message": "there are pending or running plans using current template, can not update" }

              
              {
  "code": 400,
  "message": "there are pending or running plans using current template, can not update"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Code	Beschreibung
400	400	Parameterfehler oder Fehler in der Geschäftslogik
500	500	Interner Serverfehler

Häufige Fehlermeldungen:

invalid templateId: Formatfehler der Vorlagen-ID
template config not exist: Vorlagenkonfiguration existiert nicht
there are pending or running plans using current template, can not update: Es gibt ausstehende oder laufende Pläne, die diese Vorlage verwenden, sie kann nicht gelöscht werden

Hinweise

Wenn es ausstehende oder laufende Nachrichtenpläne gibt, die diese Vorlage verwenden, kann sie nicht gelöscht werden.
Sowohl die Vorlagen- als auch die Signatur-ID sind Zahlen vom Typ String.