Enlaces compartidos
Enlace externo que da acceso a un documento publicado a cualquiera que lo tenga.
- Nombre API:
sharelinks - Dominio: Compartir
- Módulos: Administración
Campos
El nombre API es el que usan la API, MCP y la CLI.
| Nombre | Nombre API | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| ID | id | ID de registro | Sí | |
| Correo del destinatario | recipientEmail | Texto | ||
| Contacto | customercontactId | Referencia | ||
| Instantánea compartida | sharesnapshotId | Referencia | Sí | |
| Verificación | verification | Constante | Sí | Opción fija del conjunto permitido para este campo. |
| Vence el | expiresAt | Fecha y Hora | Sí | |
| Creado por | createdBy | Usuario | ||
| Creado el | createdAt | Fecha y Hora | Sí | |
| Actualizado por | updatedBy | Usuario | ||
| Actualizado el | updatedAt | Fecha y Hora | Sí | |
| Abierto por | openedBy | Usuario | ||
| Abierto el | openedAt | Fecha y Hora | ||
| Verificado por | verifiedBy | Usuario | ||
| Verificado | verifiedAt | Fecha y Hora | ||
| Cancelado por | canceledBy | Usuario | ||
| Cancelado el | canceledAt | Fecha y Hora | ||
| Bloqueado por | blockedBy | Usuario | ||
| Bloqueado el | blockedAt | Fecha y Hora | ||
| Archivado por | archivedBy | Usuario | ||
| Archivado el | archivedAt | Fecha y Hora |
Relaciones
| Campo | Apunta a | Tipo |
|---|---|---|
Contacto customercontactId | Contactos de cliente | referencia |
Instantánea compartida sharesnapshotId | Instantáneas compartidas | referencia |
Acciones
Lo que puedes hacer con un registro. Cada acción también envía el evento de webhook sharelinks.<acción>. Las lecturas (find, get, count) funcionan en toda tabla.
| Nombre | Nombre API | Descripción | Dónde |
|---|---|---|---|
| Crear | create | Crea un enlace. | App · WebMCP · API · MCP · CLI |
| Editar | update | Guarda los cambios del enlace. | App · WebMCP · API · MCP · CLI |
| Cancelar | cancel | Revierte el efecto registrado de la acción. | App · WebMCP · API · MCP · CLI |
Estados
Cómo pasa un registro de un estado a otro. Archivar y bloquear pueden ocurrir en cualquier estado.
Eventos
Momentos a los que el registro llega por sí solo. Suscríbete a ellos con un webhook.
| Nombre | Evento de webhook | Descripción |
|---|---|---|
| Primera apertura | sharelinks.firstOpened | El destinatario abrió el enlace por primera vez. |