Saltar al contenido principal

kobana dunning notification-preferences

Comandos de kobana dunning notification-preferences. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
notification-preferences listGET /v1/notification-preferencesConsultar preferencias de notificación
notification-preferences updatePUT /v1/notification-preferencesActualizar preferencias de notificación

notification-preferences list​

Consultar preferencias de notificación

kobana dunning notification-preferences list [OPCIONES]

GET /v1/notification-preferences

Devuelve el gate efectivo por tipo de mensaje — los tipos sin registro guardado aparecen con todos los canales habilitados.

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada (id o public_id, listados en GET /v1/workspaces). Opcional mientras la organización tenga un solo workspace; con dos o más, sin él la respuesta es 400 WORKSPACE_REQUIRED. Un workspace de otra organización es 403 UNKNOWN_WORKSPACE.

Respuestas

HTTPDescripción
200Preferencias efectivas por tipo.
404Recurso inexistente o fuera de tu organización.
413Cuerpo de la solicitud mayor que 2 MB.

notification-preferences update​

Actualizar preferencias de notificación

kobana dunning notification-preferences update [OPCIONES]

PUT /v1/notification-preferences

Hace upsert de las preferencias enviadas (parcial: solo los tipos incluidos se modifican).

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada (id o public_id, listados en GET /v1/workspaces). Opcional mientras la organización tenga un solo workspace; con dos o más, sin él la respuesta es 400 WORKSPACE_REQUIRED. Un workspace de otra organización es 403 UNKNOWN_WORKSPACE.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
preferencesarray<object>sí

Otros campos y objetos anidados: kobana schema dunning.notification-preferences.update.

Respuestas

HTTPDescripción
200Preferencias guardadas.
400Solicitud inválida (error de validación).
404Recurso inexistente o fuera de tu organización.
413Cuerpo de la solicitud mayor que 2 MB.