Create Custom Object

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 }'

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 "leaf_type": "foo", 28 "modified_by": { 29 "display_id": "foo", 30 "id": "foo", 31 "display_name": "foo", 32 "display_picture": { 33 "display_id": "foo", 34 "id": "foo", 35 "file": { 36 "type": "foo", 37 "name": "foo", 38 "size": 42 39 } 40 }, 41 "email": "foo", 42 "full_name": "foo", 43 "state": "active" 44 }, 45 "modified_date": "2023-01-01T12:00:00.000Z", 46 "stage": { 47 "stage": { 48 "id": "foo", 49 "display_id": "foo", 50 "name": "foo" 51 }, 52 "state": { 53 "id": "foo", 54 "display_id": "foo", 55 "is_final": true, 56 "name": "foo" 57 } 58 }, 59 "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id", 60 "subtype": "foo", 61 "sync_metadata": { 62 "external_reference": "foo", 63 "last_sync_in": { 64 "status": "failed", 65 "sync_date": "2023-01-01T12:00:00.000Z", 66 "sync_unit": { 67 "id": "foo", 68 "display_id": "foo", 69 "external_system_type": "adaas", 70 "is_archived": true, 71 "name": "foo", 72 "sync_run": { 73 "mode": "initial", 74 "progress": { 75 "state": "completed" 76 } 77 }, 78 "sync_type": "manual" 79 } 80 }, 81 "last_sync_out": { 82 "status": "failed", 83 "sync_date": "2023-01-01T12:00:00.000Z", 84 "sync_unit": { 85 "id": "foo", 86 "display_id": "foo", 87 "external_system_type": "adaas", 88 "is_archived": true, 89 "name": "foo", 90 "sync_run": { 91 "mode": "initial", 92 "progress": { 93 "state": "completed" 94 } 95 }, 96 "sync_type": "manual" 97 } 98 }, 99 "origin_system": "foo" 100 }, 101 "title": "foo", 102 "unique_key": "foo" 103 } 104 }

Creates a custom object.

Request

This endpoint expects an object.

leaf_typestringRequiredformat: "text"

Leaf type of the custom 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

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

Allowed values:

titlestringOptionalformat: "text"

Title of the custom object.

unique_keystringOptionalformat: "text"

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

Response

Success.

custom_objectobject

Headers

Request

Response

Errors