Create a template data object

POST

/project-templates/:templateId/data-objects

POST

/project-templates/:templateId/data-objects

1 curl -X POST https:/https://api/project-templates/templateId/data-objects \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "from": "library-object-12345"
6 }'

1 {
2   "definition": {
3     "_id": "obj_9876543210abcdef",
4     "scope": "template",
5     "templateId": "template_1234567890abcdef",
6     "projectId": "project_abcdef1234567890",
7     "nameSingular": "Task",
8     "namePlural": "Tasks",
9     "labelSingular": "Task Item",
10     "labelPlural": "Task Items",
11     "description": "A data object representing a task within the project template.",
12     "icon": "check_circle",
13     "color": "blue",
14     "labelFieldKey": "title",
15     "fields": [
16       {}
17     ],
18     "fieldGroups": [
19       {}
20     ],
21     "version": 3,
22     "archivedAt": "2024-05-01T12:00:00Z",
23     "createdAt": "2024-04-15T09:30:00Z",
24     "updatedAt": "2024-05-10T15:45:00Z",
25     "createdBy": "user_123abc456def",
26     "cardinality": {
27       "min": 1,
28       "max": 10
29     }
30   }
31 }

Creates a template-scoped object definition, EITHER by cloning a library source ({ from }) or from a full definition body. Requires data-object:manage.

Authentication

AuthorizationBearer

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

Path parameters

templateIdstringRequired

Request

This endpoint expects an object.

objectRequired

Response

The created object definition.

definitionobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error