Saltar al contenido

Delete a custom object record

Módulo Platform

DELETE/objects/{object_key}/{id}objects.delete

A record of a custom object. Values are stored one row per field, never as JSON. Soft-deletes the custom object record: it moves to Trash and can be restored for its table's retention period.

  • Requiere la capacidad work.record.write.
  • Alcances de OAuth: work.
  • Estados de error: 401, 404, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

objects.delete: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
object_keystringSíThe `object_key` path segment.Restricciones: length 1 to any
idstring (uuid)SíIdentifier of the custom object record.

Respuesta 204: sin cuerpo.

Ejemplos de código

curl -X DELETE "$XOS_BASE_URL/objects/sponsor_activation/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.objects.delete("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.objects.delete("sponsor_activation", "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos objects delete sponsor_activation 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f