Create Custom Object (Beta) — DevRev

Creates a custom object.

Request

This endpoint expects an object.

custom_schema_specobjectRequired

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.

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.

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 "custom_schema_spec": {}, 6 "leaf_type": "leaf_type", 7 "unique_key": "unique_key" 8 }'

1 { 2 "custom_object": { 3 "created_by": { 4 "type": "dev_user", 5 "display_picture": { 6 "file": { 7 "type": "type", 8 "name": "name" 9 }, 10 "id": "id", 11 "display_id": "display_id" 12 }, 13 "id": "id", 14 "state": "active", 15 "display_id": "display_id", 16 "display_name": "display_name", 17 "email": "email", 18 "full_name": "full_name" 19 }, 20 "id": "id", 21 "modified_by": { 22 "type": "dev_user", 23 "display_picture": { 24 "file": { 25 "type": "type", 26 "name": "name" 27 }, 28 "id": "id", 29 "display_id": "display_id" 30 }, 31 "id": "id", 32 "state": "active", 33 "display_id": "display_id", 34 "display_name": "display_name", 35 "email": "email", 36 "full_name": "full_name" 37 }, 38 "sync_metadata": { 39 "last_sync_in": { 40 "status": "failed", 41 "sync_unit": { 42 "external_system_type": "adaas", 43 "id": "id", 44 "sync_run": { 45 "mode": "initial", 46 "progress": { 47 "state": "completed" 48 } 49 }, 50 "sync_type": "manual", 51 "display_id": "display_id", 52 "is_archived": true, 53 "name": "name" 54 }, 55 "sync_date": "sync_date" 56 }, 57 "last_sync_out": { 58 "status": "failed", 59 "sync_unit": { 60 "external_system_type": "adaas", 61 "id": "id", 62 "sync_run": { 63 "mode": "initial", 64 "progress": { 65 "state": "completed" 66 } 67 }, 68 "sync_type": "manual", 69 "display_id": "display_id", 70 "is_archived": true, 71 "name": "name" 72 }, 73 "sync_date": "sync_date" 74 }, 75 "external_reference": "external_reference", 76 "origin_system": "origin_system" 77 }, 78 "created_date": "created_date", 79 "custom_fields": {}, 80 "custom_schema_fragments": [ 81 "custom_schema_fragments", 82 "custom_schema_fragments" 83 ], 84 "display_id": "display_id", 85 "modified_date": "modified_date", 86 "stock_schema_fragment": "stock_schema_fragment", 87 "subtype": "subtype" 88 } 89 }

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	"custom_schema_spec": {},
6	"leaf_type": "leaf_type",
7	"unique_key": "unique_key"
8	}'

1	{
2	"custom_object": {
3	"created_by": {
4	"type": "dev_user",
5	"display_picture": {
6	"file": {
7	"type": "type",
8	"name": "name"
9	},
10	"id": "id",
11	"display_id": "display_id"
12	},
13	"id": "id",
14	"state": "active",
15	"display_id": "display_id",
16	"display_name": "display_name",
17	"email": "email",
18	"full_name": "full_name"
19	},
20	"id": "id",
21	"modified_by": {
22	"type": "dev_user",
23	"display_picture": {
24	"file": {
25	"type": "type",
26	"name": "name"
27	},
28	"id": "id",
29	"display_id": "display_id"
30	},
31	"id": "id",
32	"state": "active",
33	"display_id": "display_id",
34	"display_name": "display_name",
35	"email": "email",
36	"full_name": "full_name"
37	},
38	"sync_metadata": {
39	"last_sync_in": {
40	"status": "failed",
41	"sync_unit": {
42	"external_system_type": "adaas",
43	"id": "id",
44	"sync_run": {
45	"mode": "initial",
46	"progress": {
47	"state": "completed"
48	}
49	},
50	"sync_type": "manual",
51	"display_id": "display_id",
52	"is_archived": true,
53	"name": "name"
54	},
55	"sync_date": "sync_date"
56	},
57	"last_sync_out": {
58	"status": "failed",
59	"sync_unit": {
60	"external_system_type": "adaas",
61	"id": "id",
62	"sync_run": {
63	"mode": "initial",
64	"progress": {
65	"state": "completed"
66	}
67	},
68	"sync_type": "manual",
69	"display_id": "display_id",
70	"is_archived": true,
71	"name": "name"
72	},
73	"sync_date": "sync_date"
74	},
75	"external_reference": "external_reference",
76	"origin_system": "origin_system"
77	},
78	"created_date": "created_date",
79	"custom_fields": {},
80	"custom_schema_fragments": [
81	"custom_schema_fragments",
82	"custom_schema_fragments"
83	],
84	"display_id": "display_id",
85	"modified_date": "modified_date",
86	"stock_schema_fragment": "stock_schema_fragment",
87	"subtype": "subtype"
88	}
89	}