Logo Site EngageLab Mark Colored TransparentDokumen
Cari

Hapus Template

Endpoint

DELETE https://otp.api.engagelab.cc/v1/template-configs/{templateId}

Autentikasi

Lihat Autentikasi untuk memahami cara melakukan autentikasi API.

Request

Parameter request

{templateId} pada URL menunjukkan ID template yang akan dihapus, ID template ini didefinisikan sendiri oleh pemanggil saat memanggil endpoint pembuatan template.

Contoh request

Header request

DELETE /v1/template-configs/{templateId} HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              DELETE /v1/template-configs/{templateId}  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Tampilkan blok kode ini di jendela mengambang

Body request

Tidak ada

Respons

Parameter respons

Field Tipe Opsi Deskripsi
code Integer Wajib Kode error, 0 berarti sukses, lainnya berarti gagal
message String Wajib Informasi respons

Contoh respons

Respons sukses

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

            
Tampilkan blok kode ini di jendela mengambang

Respons gagal

{ "code": 4001, "message": "config not exist" }
              
              {
    "code": 4001,
    "message": "config not exist"
}

            
Tampilkan blok kode ini di jendela mengambang

Kode error

Kode error http code Keterangan
1000 500 Error internal
2001 401 Autentikasi gagal, tidak menyertakan token yang benar
2002 401 Autentikasi gagal, token telah kedaluwarsa atau dinonaktifkan
2004 403 Tidak memiliki izin untuk memanggil API ini
3001 400 Format parameter request tidak valid, harap periksa apakah konten JSON sesuai dengan format parameter
3002 400 Parameter request salah, harap periksa apakah parameter request memenuhi persyaratan
4001 400 Template tidak ada
Icon Solid Transparent White Qiyu
Hubungi Sales