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

Errors

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": "foo", 6 "unique_key": "foo" 7 }'

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

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": "foo",
6	"unique_key": "foo"
7	}'

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