Create Custom Object (Beta) — DevRev

Creates a custom object.

Request

This endpoint expects an object.

leaf_typestringRequiredformat: "text"

Leaf type of the custom object.

unique_keystringRequiredformat: "text"

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

custom_fieldsobjectOptional

Custom fields of the custom object.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

stagestringOptionalformat: "id"

The stage of the custom object.

stage_validation_optionslist of enumsOptional

Allowed values: allow_non_start

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

titlestringOptionalformat: "text"

Title of the custom object.

Response

Success.

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": "dev_user", 6 "id": "id", 7 "display_id": "display_id", 8 "display_name": "display_name", 9 "display_picture": { 10 "id": "id", 11 "display_id": "display_id", 12 "file": {} 13 }, 14 "email": "email", 15 "full_name": "full_name", 16 "state": "active" 17 }, 18 "created_date": "created_date", 19 "custom_fields": {}, 20 "custom_schema_fragments": [ 21 "custom_schema_fragments", 22 "custom_schema_fragments" 23 ], 24 "display_id": "display_id", 25 "modified_by": { 26 "type": "dev_user", 27 "id": "id", 28 "display_id": "display_id", 29 "display_name": "display_name", 30 "display_picture": { 31 "id": "id", 32 "display_id": "display_id", 33 "file": {} 34 }, 35 "email": "email", 36 "full_name": "full_name", 37 "state": "active" 38 }, 39 "modified_date": "modified_date", 40 "stock_schema_fragment": "stock_schema_fragment", 41 "subtype": "subtype", 42 "sync_metadata": { 43 "external_reference": "external_reference", 44 "last_sync_in": { 45 "status": "failed", 46 "sync_date": "sync_date", 47 "sync_unit": { 48 "id": "id", 49 "display_id": "display_id", 50 "external_system_type": "adaas", 51 "is_archived": true, 52 "name": "name", 53 "sync_run": {}, 54 "sync_type": "manual" 55 } 56 }, 57 "last_sync_out": { 58 "status": "failed", 59 "sync_date": "sync_date", 60 "sync_unit": { 61 "id": "id", 62 "display_id": "display_id", 63 "external_system_type": "adaas", 64 "is_archived": true, 65 "name": "name", 66 "sync_run": {}, 67 "sync_type": "manual" 68 } 69 }, 70 "origin_system": "origin_system" 71 } 72 } 73 }

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": "dev_user",
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name",
9	"display_picture": {
10	"id": "id",
11	"display_id": "display_id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"custom_fields": {},
20	"custom_schema_fragments": [
21	"custom_schema_fragments",
22	"custom_schema_fragments"
23	],
24	"display_id": "display_id",
25	"modified_by": {
26	"type": "dev_user",
27	"id": "id",
28	"display_id": "display_id",
29	"display_name": "display_name",
30	"display_picture": {
31	"id": "id",
32	"display_id": "display_id",
33	"file": {}
34	},
35	"email": "email",
36	"full_name": "full_name",
37	"state": "active"
38	},
39	"modified_date": "modified_date",
40	"stock_schema_fragment": "stock_schema_fragment",
41	"subtype": "subtype",
42	"sync_metadata": {
43	"external_reference": "external_reference",
44	"last_sync_in": {
45	"status": "failed",
46	"sync_date": "sync_date",
47	"sync_unit": {
48	"id": "id",
49	"display_id": "display_id",
50	"external_system_type": "adaas",
51	"is_archived": true,
52	"name": "name",
53	"sync_run": {},
54	"sync_type": "manual"
55	}
56	},
57	"last_sync_out": {
58	"status": "failed",
59	"sync_date": "sync_date",
60	"sync_unit": {
61	"id": "id",
62	"display_id": "display_id",
63	"external_system_type": "adaas",
64	"is_archived": true,
65	"name": "name",
66	"sync_run": {},
67	"sync_type": "manual"
68	}
69	},
70	"origin_system": "origin_system"
71	}
72	}
73	}