SnozeDevelopers
API referenceDatabases

Update a relation's label and delete behavior

Renames the link and changes its `onDelete` behavior; the two ends, their fields and their cardinalities are immutable. Requires the `databases:write` permission on both databases the relation joins, and responds with not-found when the relation has no end on the database in the path. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

PATCH
/v1/workspaces/{workspaceId}/databases/{databaseId}/relations/{relationId}

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
databaseId*string
relationId*string

Request Body

application/json
  1. body
label?string|null
onDelete?|null
clientMutationId?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.snoze.dev/v1/workspaces/string/databases/string/relations/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "id": "string",    "workspaceId": "string",    "label": "string",    "fromDatabaseId": "string",    "fromFieldId": "string",    "fromCardinality": "one",    "toDatabaseId": "string",    "toFieldId": "string",    "toCardinality": "one",    "onDelete": "detach",    "createdAt": "string",    "updatedAt": "string"  }}

List the relations touching a database

Returns every relation with an end on this database, including the database and field at the far end, both cardinalities, the configured delete behavior, and a `near` marker naming the end this database owns. Requires the `databases:read` permission.

Delete a relation and both of its fields

Removes the relation as a whole - both end fields and every link between records - in one transaction; there is no way to delete a single side. Requires the `databases:write` permission on both databases the relation joins, and responds with not-found when the relation has no end on the database in the path. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.