Delete a record

View as Markdown

Soft-deletes a record (sets deletedAt). Blocked when it would drop the live count below the declared minimum cardinality (409). Requires data-record:delete on the project.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired
The parent project id.
objectIdstringRequired

The project-scoped object definition id.

recordIdstringRequired
The record id.

Response

The record was soft-deleted.

okboolean

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error