Saltar al contenido
Facturador

Editar suscriptor

PUT /api/subscriptions/subscribers/{subscriber_id}

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Edita el suscriptor. Edición parcial (también acepta PATCH): lo que no envías se conserva, incluidas sus direcciones adicionales y los datos extra no enviados.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor). Los registros de suscripciones son de toda la empresa: un vendedor ve y gestiona los mismos que el administrador.

Formato de respuesta: estándar {success, data, message?} (registro único).

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
subscriber_id integer Sí Id del suscriptor (cliente).

Cuerpo (JSON):

Campo Tipo Obligatorio Descripción / valores permitidos
identity_document_type_id string No Tipo de documento: 1 DNI, 6 RUC, 4 carnet de extranjería, 7 pasaporte, 0 sin documento.
number string No Número de documento. Único entre los clientes.
name string No Nombre o razón social. Único entre los clientes.
trade_name string No Nombre comercial.
email string (email) No Correo: a él llegan los avisos de cobro con el enlace de pago.
telephone string No Teléfono.
address string No Dirección. Obligatoria salvo con DNI, carnet de extranjería o RUC 10.
country_id string No País. Por defecto PE.
location_id array [departamento, provincia, distrito] No Ubigeo, p. ej. ["15", "1501", "150116"].
parent_id integer No Id del suscriptor padre (para registrar un hijo). 0 o sin enviar = sin padre.
discord_user / slack_channel / discord_channel / gitlab_user string No Datos extra del suscriptor.
servers array No Servidores del suscriptor: {id?, host, ip, user, password}. Con id edita uno existente del mismo suscriptor; sin id agrega uno.

Reglas:

  • En servers, un servidor con id debe ser de este suscriptor. Si no envías password, se conserva la guardada.

Errores:

  • 404 si el registro no existe.
  • 422 {success: false, message: {campo: [errores]}} si falla la validación de campos.
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
subscriber_id ruta sí 1520

Cuerpo

Content-Type: application/json

{
  "telephone": "912345678",
  "slack_channel": "#soporte",
  "servers": [
    {
      "id": 12,
      "host": "vps2.midominio.pe"
    }
  ]
}

Respuestas

200 — Editado

{
  "success": true,
  "data": {
    "id": 1520,
    "identity_document_type_id": "1",
    "number": "45879632",
    "name": "MARÍA FERNANDA QUISPE ROJAS",
    "trade_name": null,
    "email": "maria.quispe@correo.pe",
    "telephone": "912345678",
    "address": "Av. Arequipa 1450, Lince",
    "country_id": "PE",
    "location_id": [
      "15",
      "1501",
      "150116"
    ],
    "parent_id": null,
    "discord_user": "mquispe",
    "slack_channel": "#soporte",
    "discord_channel": "#socios-gold",
    "gitlab_user": null,
    "subscriptions_count": 1,
    "servers": [
      {
        "id": 12,
        "host": "vps2.midominio.pe",
        "ip": "190.12.45.8",
        "user": "deploy",
        "has_password": true
      }
    ]
  },
  "message": "Suscriptor editado con éxito"
}

404 — No existe

{
  "success": false,
  "message": "Registro no encontrado."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.