Skip to main content
POST
enrollment
Generar un enlace de enrolamiento para que el ejecutivo pueda detonarlo.

Objetivo

Este endpoint permite crear una URL de enrolamiento por persona dentro de un expediente existente, para iniciar el proceso desde el canal de atención (por ejemplo, Microsoft Teams).

¿Cuándo usarlo?

Úsalo cuando:
  • Ya cuentas con un DocumentId válido del expediente.
  • Ya identificaste a la persona (PersonId) que debe completar su enrolamiento.
  • En la petición de tracking, el campo IsEnrollmentAllowed es true.

Datos requeridos

La petición requiere:
  • DocumentId: identificador del expediente.
  • PersonId: identificador de la persona a enrolar.
  • AgentMail: correo del ejecutivo que dispara la acción.
Ejemplo de payload:

Respuesta esperada (200)

Cuando la operación es exitosa, se devuelve un objeto con:
  • Code: código de resultado interno.
  • Status: estado general de la operación.
  • Message: mensaje descriptivo.
  • Data.Id: identificador del registro generado.
  • Data.EnrollmentUrl: URL de enrolamiento lista para compartirse con el ejecutivo.
Ejemplo:

Posibles respuestas de error

Recomendación operativa

Después de generar EnrollmentUrl, compártela de inmediato al ejecutivo y registra el seguimiento con el endpoint de tracking para monitorear el avance del enrolamiento.

Headers

NUFI-API-KEY
string
required
X-Workspace
string
required

Body

application/json
DocumentId
string
required
PersonId
string
required
AgentMail
string
required

Response

OK

Code
integer
Example:

200

Status
string
Example:

"Success"

Message
string
Example:

"Enrolamiento generado"

Data
object