Custom Objects Create (Beta) — DevRev

Creates a custom object.

Request

This endpoint expects an object.

leaf_typestringRequired

Leaf type of the custom object.

unique_keystringRequired

The unique key of the custom object.This can be used to hold an external reference to another object.

custom_fieldsmap from strings to anyOptional

Custom fields of the custom object.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

stagestringOptional

The stage of the custom object.

stage_validation_optionslist of "allow_non_start"Optional

The type of stage validations options when creating a custom object.

titlestringOptional

Title of the custom object.

Response

This endpoint returns an object.

custom_objectobject

1 curl -X POST https://api.devrev.ai/custom-objects.create \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "leaf_type": "leaf_type", 6 "unique_key": "unique_key" 7 }'

1 { 2 "custom_object": { 3 "id": "id", 4 "created_by": { 5 "type": "sys_user", 6 "id": "created_by", 7 "display_id": "created_by", 8 "display_name": "created_by", 9 "display_picture": { 10 "id": "id" 11 }, 12 "email": "created_by", 13 "full_name": "created_by", 14 "state": "active" 15 }, 16 "created_date": "2023-01-01T12:00:00Z", 17 "custom_fields": { 18 "key": "value" 19 }, 20 "custom_schema_fragments": [ 21 "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>" 22 ], 23 "display_id": "display_id", 24 "modified_by": { 25 "type": "sys_user", 26 "id": "modified_by", 27 "display_id": "modified_by", 28 "display_name": "modified_by", 29 "display_picture": { 30 "id": "id" 31 }, 32 "email": "modified_by", 33 "full_name": "modified_by", 34 "state": "active" 35 }, 36 "modified_date": "2023-01-01T12:00:00Z", 37 "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>", 38 "subtype": "subtype" 39 } 40 }

1	curl -X POST https://api.devrev.ai/custom-objects.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"leaf_type": "leaf_type",
6	"unique_key": "unique_key"
7	}'

1	{
2	"custom_object": {
3	"id": "id",
4	"created_by": {
5	"type": "sys_user",
6	"id": "created_by",
7	"display_id": "created_by",
8	"display_name": "created_by",
9	"display_picture": {
10	"id": "id"
11	},
12	"email": "created_by",
13	"full_name": "created_by",
14	"state": "active"
15	},
16	"created_date": "2023-01-01T12:00:00Z",
17	"custom_fields": {
18	"key": "value"
19	},
20	"custom_schema_fragments": [
21	"don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
22	],
23	"display_id": "display_id",
24	"modified_by": {
25	"type": "sys_user",
26	"id": "modified_by",
27	"display_id": "modified_by",
28	"display_name": "modified_by",
29	"display_picture": {
30	"id": "id"
31	},
32	"email": "modified_by",
33	"full_name": "modified_by",
34	"state": "active"
35	},
36	"modified_date": "2023-01-01T12:00:00Z",
37	"stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
38	"subtype": "subtype"
39	}
40	}