Eliminar configuración de plantilla

Elimina la configuración de plantilla indicada. Si la plantilla está siendo usada por un plan de mensajes (en estado pendiente de envío o en ejecución), no se puede eliminar.

URL de solicitud

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

Validación de la llamada

Consulta Validación de la llamada para saber cómo realizar la autenticación de la API.

Ejemplo de solicitud

Encabezado de la solicitud

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

            
Este bloque de código se muestra en una ventana flotante

Cuerpo de la solicitud

Ninguno

Parámetros de solicitud

Parámetros de ruta

Parámetro Tipo Opciones Descripción
templateId String Obligatorio ID de la plantilla

Parámetros de respuesta

Respuesta correcta

El código de estado HTTP es 200 y el cuerpo de la respuesta contiene los siguientes campos:

Campo Tipo Descripción
code Integer Código de estado, 0 indica éxito
message String Descripción del estado

Ejemplo correcto

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

            
Este bloque de código se muestra en una ventana flotante

Respuesta con error

El código de estado HTTP es 4xx/5xx y el cuerpo de la respuesta contiene los siguientes campos:

Campo Tipo Descripción
code Integer Código de error
message String Detalle del error

Ejemplo de 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"
}

            
Este bloque de código se muestra en una ventana flotante

Códigos de error

Código de error http code Descripción
400 400 Error de parámetros o de lógica de negocio
500 500 Error interno del servidor

Mensajes de error comunes:

  • invalid templateId: formato del ID de plantilla incorrecto
  • template config not exist: la configuración de plantilla no existe
  • there are pending or running plans using current template, can not update: hay planes pendientes de envío o en ejecución que usan esta plantilla, no se puede eliminar

Consideraciones

  1. Si hay planes de mensajes pendientes de envío o en ejecución que usan esta plantilla, no se puede eliminar
  2. Tanto el ID de la plantilla como el de la firma son números de tipo cadena
Icon Solid Transparent White Qiyu
Contacto