Menghapus Konfigurasi Template

Menghapus konfigurasi template tertentu. Jika template sedang digunakan oleh plan pesan (status menunggu kirim atau sedang berjalan), maka tidak dapat dihapus.

Alamat Panggilan

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

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request 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

Tampilkan blok kode ini di jendela mengambang

Request Body

Tidak ada

Parameter Request

Parameter Path

Parameter	Tipe	Opsi	Penjelasan
templateId	String	Wajib	ID template

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berisi field-field berikut:

Field	Tipe	Deskripsi
code	Integer	Status code, 0 berarti sukses
message	String	Deskripsi status

Contoh Sukses

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

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

Tampilkan blok kode ini di jendela mengambang

Response Gagal

HTTP status code adalah 4xx/5xx, response body berisi field-field berikut:

Field	Tipe	Deskripsi
code	Integer	Kode error
message	String	Detail error

Contoh Error

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

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error	http code	Penjelasan
400	400	Error parameter atau error logika bisnis
500	500	Error internal server

Pesan error umum:

invalid templateId: Format ID template salah
template config not exist: Konfigurasi template tidak ada
there are pending or running plans using current template, can not update: Terdapat plan menunggu kirim atau sedang berjalan yang menggunakan template ini, tidak dapat dihapus

Catatan Penting

Jika terdapat plan pesan menunggu kirim atau sedang berjalan yang menggunakan template ini, maka tidak dapat dihapus
ID template dan signature keduanya bertipe angka dalam bentuk string