Memperbarui Konfigurasi Signature

Memperbarui konfigurasi signature yang sudah ada, mendukung perubahan nama signature. Setelah diperbarui, status signature akan kembali menjadi "Menunggu Peninjauan".

Alamat Panggilan

PUT https://smsapi.engagelab.com/v1/sign-configs/:signId

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

              
              PUT /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

              
              {
  "sign_name": "Nama Perusahaan"
}

            

Parameter Request

Parameter Path

Parameter Request Body

Parameter Response

Response Sukses

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

Contoh Sukses

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

            

Response Gagal

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

Contoh Error

              
              {
  "code": 400,
  "message": "can not update pending status sign"
}

            

Kode Error

Pesan error umum:

• invalid signId: Format ID signature salah
• sign config not exist: Konfigurasi signature tidak ada
• sign_name already exist: Nama signature sudah ada
• can not update pending status sign: Signature berstatus menunggu peninjauan tidak dapat diperbarui
• there are pending or running plans using current sign, can not update: Terdapat plan menunggu kirim atau sedang berjalan yang menggunakan signature ini, tidak dapat diperbarui

Catatan Penting

1. Signature berstatus menunggu peninjauan tidak dapat diperbarui
2. Jika terdapat plan pesan menunggu kirim atau sedang berjalan yang menggunakan signature ini, maka tidak dapat diperbarui
3. Setelah diperbarui, status signature akan kembali menjadi "Menunggu Peninjauan" (status=1)
4. Nama signature tidak boleh mengandung karakter terlarang: 【、】、[、]
5. ID signature bertipe angka dalam bentuk string

Lampiran

Status Konfigurasi Signature (status)