Saltar al contenido principal
POST
Add assets to organization allowlist

Descripción general

Agrega en lote varios assets (Asset: activo digital, como una URL, dirección, perfil, app, etc.) a la Allowlist (lista de permitidos) de tu organización. Cada asset se analiza automáticamente, se clasifica por tipo y se aprueba con el estado ALLOWED. Este endpoint permite agregar hasta 1,000 assets por solicitud, con metadatos opcionales como nombre, descripción y asignación a un grupo.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-API-KEY:

Solicitud de ejemplo

Cuerpo de la solicitud

Definir un vencimiento al agregar

A los assets que solo deben permanecer por un tiempo, como el sitio de un socio, se les puede asignar un vencimiento en la allowlist en la misma solicitud. Define expiresAt en la solicitud para aplicar una misma fecha a todos los assets, o en un asset para darle su propia fecha. La fecha propia de un asset tiene prioridad sobre la de la solicitud.
  • El vencimiento solo se define en los assets que se agregaron. Los assets que no se pudieron agregar no reciben ninguno.
  • Cada fecha debe estar en el futuro. Si alguna no lo está, la solicitud devuelve 400 y no se agrega nada.
  • Para cambiar un vencimiento más adelante, usa Definir vencimiento de assets de la organización.

Tipos de asset admitidos

El endpoint detecta y clasifica automáticamente los siguientes tipos de asset:
  • URL - URL completas con protocolo (p. ej., https://example.com)
  • ADDRESS - Direcciones de blockchain (p. ej., direcciones de Ethereum o Bitcoin)
  • PAGE - Identificadores de páginas web
  • DISCORD - Identificadores de servidores o canales de Discord
  • TELEGRAM - Identificadores de canales o grupos de Telegram
  • TWITTER - Handles de Twitter/X (p. ej., @username)
  • INSTAGRAM - Handles de Instagram
  • MEDIUM - Identificadores de publicaciones o usuarios de Medium
  • GITHUB - Identificadores de repositorios o usuarios de GitHub
  • YOUTUBE - Identificadores de canales de YouTube
  • LINKEDIN - Identificadores de perfiles de LinkedIn
  • TWITCH - Identificadores de canales de Twitch
  • TIKTOK - Identificadores de handles de TikTok
  • EMAIL - Direcciones de correo electrónico

Respuesta

Respuesta exitosa

Respuesta con éxito parcial

Cuando algunos assets se agregan correctamente y otros fallan:

Campos de la respuesta

Respuestas de error

400 Bad Request

Se devuelve cuando la solicitud está mal formada o supera los límites:

401 Unauthorized

Se devuelve cuando falta la clave de API, no es válida o no tiene acceso a la organización:

404 Not Found

Se devuelve cuando un ID de grupo especificado no existe:

Mensajes de error comunes

Buenas prácticas

Operaciones en lote

  • Maximiza el rendimiento: usa el límite completo de 1,000 assets por solicitud cuando hagas importaciones masivas
  • Maneja los fallos parciales: revisa siempre tanto successCount como errorCount en las respuestas
  • Reintenta los assets fallidos: extrae de los resultados los assets que fallaron y reinténtalos con los datos corregidos

Formato de los assets

  • URL: incluye el protocolo (https:// o http://)
    • ✅ https://example.com
    • ❌ example.com (se interpretará como dominio, no como URL)
  • Direcciones de blockchain: usa el formato de dirección completo
    • ✅ 0x1234567890abcdef1234567890abcdef12345678
  • Handles de redes sociales: incluye el símbolo @ para Twitter y otras plataformas sociales
    • ✅ @username
    • ✅ username (también funciona)

Metadatos

  • Nombres: usa nombres descriptivos para identificarlos más fácilmente en tu dashboard
  • Descripciones: agrega contexto sobre el propósito del asset, sobre todo en el caso de direcciones y URL
  • Grupos: organiza los assets por tipo, proyecto o propósito mediante grupos

Manejo de errores

  • Revisa el arreglo results para conocer el estado de éxito o fallo de cada asset
  • Usa successCount y errorCount para los informes agregados
  • Registra los assets fallidos con sus mensajes de error para depurar
  • Implementa una lógica de reintento para los assets fallidos después de corregir los problemas

Casos de uso

Importar desde una hoja de cálculo

Agregar varios tipos de asset

Notas

  • Los assets se analizan y se clasifican por tipo automáticamente
  • Todos los assets agregados correctamente reciben el estado ALLOWED
  • Los assets duplicados (que ya están en tu organización) fallarán con el error correspondiente
  • El endpoint devuelve un éxito parcial: algunos assets pueden agregarse correctamente mientras otros fallan
  • La organización se determina automáticamente a partir de tu clave de API
  • Los ID de grupo deben pertenecer a tu organización
  • La validación de los assets ocurre durante el procesamiento; los formatos no válidos se informarán en los resultados

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Cuerpo

application/json

Add assets to organization allowlist

Batch add multiple assets to your organization's allowlist. Each asset will be automatically parsed and classified. Assets are normally auto-approved as ALLOWED. Two cases go to manual review instead: an asset ChainPatrol currently has BLOCKED, because allowlisting one is an unblock, and requests from integration organizations. The response still reports each asset as added; the status change follows once a reviewer approves it. Pass expiresAt to give the assets an allowlist expiry, for example for a partner's site.

assets
object[]
requerido

Array of assets to add (max 1000 per request)

Required array length: 1 - 1000 elements
expiresAt
string<date-time>

Optional allowlist expiry for every asset in the request, as an ISO 8601 date-time in the future (e.g. 2027-04-30T23:59:59Z). After it passes, the assets stay on your organization for a 14-day grace period, then are removed from it; their status does not change. An asset's own expiresAt overrides this.

Respuesta

Successful response

Batch add operation results

results
object[]
requerido

Results for each asset

successCount
number
requerido

Number of assets successfully added

errorCount
number
requerido

Number of assets that failed to add