Archive a data object

DELETE

/data-objects/:id

DELETE

/data-objects/:id

1 curl -X DELETE https:/https://api/data-objects/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "definition": {
3     "_id": "a3f1c9d2-4b7e-4f3a-9d2e-8b7c6f1a2d3e",
4     "scope": "library",
5     "templateId": "tpl_9f8e7d6c5b4a3",
6     "projectId": null,
7     "nameSingular": "Task",
8     "namePlural": "Tasks",
9     "labelSingular": "Task",
10     "labelPlural": "Tasks",
11     "description": "A data object representing a task in the project management system.",
12     "icon": "check-circle",
13     "color": "#4A90E2",
14     "labelFieldKey": "title",
15     "fields": [
16       {
17         "key": "title",
18         "type": "string",
19         "required": true,
20         "label": "Title"
21       }
22     ],
23     "fieldGroups": [
24       {
25         "name": "General",
26         "fields": [
27           "title"
28         ]
29       }
30     ],
31     "version": 3,
32     "archivedAt": "2024-06-01T12:00:00Z",
33     "createdAt": "2023-11-15T09:30:00Z",
34     "updatedAt": "2024-05-20T16:45:00Z",
35     "createdBy": "user_7d9f8e6c5b4a3",
36     "cardinality": {
37       "min": 1,
38       "max": null
39     }
40   }
41 }

Soft-deletes (archives) an object definition. Project-scoped definitions with existing records require ?purge=true. Authorization is scope-dependent (library/template need data-object:manage; project-scoped need project:object-manage).

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Query parameters

purgebooleanOptional

Allow archiving a project-scoped definition that still has records.

Response

The archived object definition.

definitionobject or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error