Crear suscriptor
POST /api/subscriptions/subscribers
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Registra un cliente como suscriptor, con las mismas validaciones que el registro de clientes del sistema.
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). Responde 201 con el suscriptor creado (incluye su id y servers).
Cuerpo (JSON):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
identity_document_type_id |
string | Sí al crear | Tipo de documento: 1 DNI, 6 RUC, 4 carnet de extranjería, 7 pasaporte, 0 sin documento. |
number |
string | Sí al crear | Número de documento. Único entre los clientes. |
name |
string | Sí al crear | 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 | Con RUC 20 | 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] | Con RUC 20 en PE | 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:
- Se registra como cliente (
customers): queda disponible también para emitir comprobantes. - Para registrar un hijo envía
parent_idcon el id de otro suscriptor.
Errores:
422{success: false, message: {campo: [errores]}}si falla la validación de campos. (falta documento o nombre, número o nombre repetido, correo inválido o repetido, padre inexistente; con RUC 20: falta la dirección o el ubigeo, conmessagede texto).401sin token o con un token inválido.
Cuerpo
Content-Type: application/json
{
"identity_document_type_id": "1",
"number": "45879632",
"name": "MARÍA FERNANDA QUISPE ROJAS",
"email": "maria.quispe@correo.pe",
"telephone": "987654321",
"address": "Av. Arequipa 1450, Lince",
"discord_user": "mquispe",
"discord_channel": "#socios-gold"
}
Respuestas
201 — Creado
{
"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": "987654321",
"address": "Av. Arequipa 1450, Lince",
"country_id": "PE",
"location_id": [
"15",
"1501",
"150116"
],
"parent_id": null,
"discord_user": "mquispe",
"slack_channel": null,
"discord_channel": "#socios-gold",
"gitlab_user": null,
"subscriptions_count": 0,
"servers": []
},
"message": "Suscriptor registrado con éxito"
}
422 — Número repetido
{
"success": false,
"message": {
"number": [
"El campo número ya ha sido registrado."
]
}
}
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.