Create a library data object

POST

/data-objects

POST

/data-objects

1 curl -X POST https:/https://api/data-objects \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "nameSingular": "Task",
6   "namePlural": "Tasks",
7   "labelSingular": "Task",
8   "labelPlural": "Tasks",
9   "icon": "check-circle",
10   "labelFieldKey": "title",
11   "fields": [
12     {
13       "key": "title",
14       "label": "Title",
15       "type": "text"
16     }
17   ]
18 }'

1 {
2   "definition": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "scope": "library",
5     "templateId": "null",
6     "projectId": "null",
7     "nameSingular": "Task",
8     "namePlural": "Tasks",
9     "labelSingular": "Task",
10     "labelPlural": "Tasks",
11     "description": "A task represents a unit of work to be completed.",
12     "icon": "check-circle",
13     "color": "#4CAF50",
14     "labelFieldKey": "title",
15     "fields": [
16       {}
17     ],
18     "fieldGroups": [
19       {}
20     ],
21     "version": 1,
22     "archivedAt": "null",
23     "createdAt": "2024-06-15T10:00:00Z",
24     "updatedAt": "2024-06-15T10:00:00Z",
25     "createdBy": "user_1234567890abcdef",
26     "cardinality": {
27       "min": 1,
28       "max": 1
29     }
30   }
31 }

Creates a new org-shared (library-scope) object definition. Requires data-object:manage.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

nameSingularstringRequired1-64 characters

namePluralstringRequired1-64 characters

labelSingularstringRequired1-200 characters

labelPluralstringRequired1-200 characters

iconstringRequired1-64 characters

labelFieldKeystringRequired>=1 character

fieldslist of objectsRequired

descriptionstringOptional<=2000 charactersDefaults to

colorstring or nullOptional

fieldGroupslist of objectsOptionalDefaults to []

cardinalityobjectOptional

Response

The created object definition.

definitionobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error