Actualizar un proveedor

Utiliza este endpoint para actualizar la configuración de un proveedor. Ten en cuenta que category y type no se pueden cambiar después de la creación.

PATCH /v1/providers/{id}

Actualizar un proveedor

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/providers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "sendgrid-primary-v2",
  "host": "smtp.sendgrid.net",
  "port": 465,
  "disableSsl": true
}
'

200

Example

{
  "id": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "name": "sendgrid-primary-v2",
  "category": "Email",
  "type": "SendGrid",
  "host": "smtp.sendgrid.net",
  "port": 465,
  "disableSsl": true,
  "createdAt": "2025-04-08T08:01:30.000Z"
}

Autorizaciones

Authorization · string · header · requerido

El token de autorización en formato 'Bearer '.

Parámetros de ruta

id · string · requerido

The unique identifier of the provider.

Cuerpo

application/json

Información utilizada para actualizar un proveedor existente. Ten en cuenta que category y type son inmutables después de la creación.

name · string

Nombre actualizado del proveedor.

subType · string

Subtipo del proveedor actualizado.

method · string

Método de autenticación o entrega actualizado.

clientId · string

Identificador de cliente o clave API actualizado.

clientSecret · string

Secreto de cliente o secreto de API actualizado.

clientId2 · string

Identificador de cliente secundario actualizado.

clientSecret2 · string

Secreto de cliente secundario actualizado.

host · string

Dirección del host SMTP o de la API actualizada.

port · integer

Puerto SMTP actualizado.

disableSsl · boolean

Configuración de SSL/TLS actualizada.

title · string

Título o asunto predeterminado actualizado.

content · string

Plantilla de contenido de mensaje predeterminada actualizada.

receiver · string

Dirección del receptor predeterminada actualizada.

regionId · string

ID de región en la nube actualizado.

signName · string

Nombre de firma SMS actualizado.

templateCode · string

Código de plantilla SMS actualizado.

appId · string

Identificador de la aplicación actualizado.

endpoint · string

URL del endpoint de la API del proveedor actualizado.

intranetEndpoint · string

Endpoint de intranet actualizado.

domain · string

Dominio del proveedor actualizado.

Respuesta

200

application/json

Indica que el proveedor se actualizó correctamente y que la operación se completó según lo esperado.

Información sobre un proveedor de comunicación.

id · string

Identificador único del proveedor.

name · string

Nombre del proveedor.

category · enum<string>

Categoría del proveedor.

Opciones disponibles: Email, SMS

type · enum<string>

Tipo de implementación del proveedor.

Opciones disponibles: SendGrid, Twilio

subType · string

Subtipo del proveedor, si corresponde.

method · string

Método de autenticación o entrega.

clientId · string

Identificador de cliente o clave API (el secreto nunca se devuelve).

clientId2 · string

Identificador de cliente secundario, si corresponde.

host · string

Dirección del host SMTP o de la API.

port · integer

Puerto SMTP.

disableSsl · boolean

Indica si SSL/TLS está deshabilitado.

title · string

Título o asunto predeterminado del correo electrónico o SMS.

content · string

Plantilla de contenido de mensaje predeterminada.

receiver · string

Dirección del receptor predeterminada para pruebas.

regionId · string

ID de región en la nube (específico del proveedor).

signName · string

Nombre de firma SMS (específico del proveedor).

templateCode · string

Código de plantilla SMS (específico del proveedor).

appId · string

Identificador de la aplicación (específico del proveedor).

endpoint · string

URL del endpoint de la API del proveedor.

intranetEndpoint · string

Endpoint de intranet para el acceso a la red privada.

domain · string

Dominio del proveedor.

providerUrl · string

URL específica del proveedor.

createdAt · string<date-time>

Marca de tiempo que indica cuándo se creó el proveedor.