Saltar al contenido principal
PATCH
Update organization asset

Descripción general

Actualiza el nombre, la descripción o la asignación de grupo de un Asset (activo digital: URL, dirección, perfil, app, etc.). Este endpoint te permite modificar los metadatos de los assets que pertenecen a tu organización. El contenido y el tipo del asset no se pueden cambiar: crea un asset nuevo si necesitas modificar esos campos.

Inicio rápido

Autenticación

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

Solicitud de ejemplo

Parámetros de ruta

Cuerpo de la solicitud

Para actualizar el asset se debe proporcionar al menos uno de estos campos: name, description o groupId.

Respuesta

Respuesta exitosa

Campos de la respuesta

Operaciones de actualización

Actualizar solo el nombre

Actualizar solo la descripción

Borrar la descripción

Cambiar la asignación de grupo

Mueve el asset a otro grupo:

Quitar el asset del grupo

Quita el asset de todos los grupos:

Actualizar varios campos

Respuestas de error

400 Bad Request

Se devuelve cuando la solicitud está mal formada o contiene datos no válidos:

401 Unauthorized

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

403 Forbidden

Se devuelve cuando el asset no pertenece a tu organización:

404 Not Found

Se devuelve cuando el ID del asset o el ID del grupo no existe:

Mensajes de error comunes

Buenas prácticas

Actualización de campos

  • Actualizaciones parciales: incluye solo los campos que quieras cambiar
  • Null frente a omitir:
    • Pasa null para borrar un campo (description, groupId)
    • Omite el campo para dejarlo sin cambios
  • Validación: valida que los ID de grupo existan antes de actualizar

Actualizaciones masivas

Cuando actualices varios assets, procésalos de forma secuencial o en lotes pequeños:

Manejo de errores

  • Verifica la propiedad del asset antes de actualizarlo (comprueba si el asset pertenece a tu organización)
  • Valida los ID de grupo antes de asignarlos
  • Maneja los errores 404 de forma controlada (es posible que el asset se haya eliminado)
  • Registra las actualizaciones fallidas con fines de auditoría

Casos de uso

Organizar assets en grupos

Agregar descripciones a los assets

Notas

  • El contenido y el tipo del asset no se pueden modificar: crea un asset nuevo si lo necesitas
  • Solo se pueden actualizar los assets que pertenecen a tu organización
  • La organización se determina automáticamente a partir de tu clave de API
  • Todas las operaciones de actualización son atómicas: o se actualizan todos los campos o no se actualiza ninguno
  • La respuesta contiene la información actualizada del asset
  • La marca de tiempo updatedAt del asset se actualizará cuando cambie cualquier campo

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.

Parámetros de ruta

assetId
integer
requerido

ID of the asset to update

Rango requerido: x > 0

Cuerpo

application/json

Update an organization asset

Update the name, description, or group assignment of an asset.

name
string

New display name for the asset

description
string | null

New description for the asset

groupId
integer | null

New group ID (null to ungroup)

Rango requerido: x > 0

Respuesta

Successful response

Updated asset

id
number
requerido

Asset ID

content
string
requerido

Asset content

name
string | null
requerido

Asset display name

description
string | null
requerido

Asset description

groupId
number | null
requerido

Group ID