Skip to content

Commit d60f276

Browse files
committed
Update headings as per guidelines
1 parent 713a782 commit d60f276

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

fern/docs/pages/custom-objects.mdx

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
# Custom Objects
1+
# Custom objects
22

3-
## Table of Contents
3+
## Table of contents
44

55
1. [Introduction](#custom-objects)
6-
2. [Quick Start](#quick-start)
7-
- [Create a Schema and a Custom Object](#create-a-schema-and-a-custom-object)
8-
- [Get a Custom Object](#get-a-custom-object)
9-
- [List Custom Objects](#list-custom-objects)
10-
- [Update a Custom Object](#update-a-custom-object)
11-
- [Delete a Custom Object](#delete-a-custom-object)
12-
3. [Key Concepts](#key-concepts)
13-
4. [Custom Object Lifecycle](#custom-object-lifecycle)
6+
2. [Quick start](#quick-start)
7+
- [Create a Schema and a custom object](#create-a-schema-and-a-custom-object)
8+
- [Get a custom object](#get-a-custom-object)
9+
- [List custom objects](#list-custom-objects)
10+
- [Update a custom object](#update-a-custom-object)
11+
- [Delete a custom object](#delete-a-custom-object)
12+
3. [Key concepts](#key-concepts)
13+
4. [Custom object lifecycle](#custom-object-lifecycle)
1414

1515
- - -
1616

1717
## Introduction
18-
Custom objects allow you to extend DevRev's data model beyond the standard use-cases served by the native apps (build, support, etc).
19-
Custom Objects allow you to create and manage object types tailored to your specific business needs.
18+
Custom objects allow you to extend DevRev's data model beyond the standard use-cases served by the native apps like Build and Support.
19+
Custom objects allow you to create and manage object types tailored to your specific business needs.
2020

21-
## Quick Start
21+
## Quick start
2222

2323
Let's say you want to manage marketing campaigns on DevRev. We'll go through the process of creating a "Campaign" custom object with relevant fields.
2424

2525
All DevRev objects require a schema. So, we'll first create a schema for the "Campaign" custom object. Make sure to replace the `<YOUR_API_TOKEN>` with your actual API token.
2626

27-
### Create a Schema and a Custom Object
27+
### Create a schema and a custom object
2828

2929
```
3030
curl --location 'https://api.devrev.ai/schemas.custom.set' \
@@ -120,9 +120,9 @@ The response of the above API call will be the ID of the custom object created.
120120

121121
Note that the `id` field in the above response is the system generated ID for the custom object.
122122

123-
The sections below provide more details on the available API endpoints for interacting with Custom Objects.
123+
The sections below provide more details on the available API endpoints for interacting with custom objects.
124124

125-
### Get a Custom Object
125+
### Get a custom object
126126

127127
To get a custom object, use the `custom-objects.get` endpoint:
128128

@@ -136,7 +136,7 @@ curl --location 'https://api.devrev.ai/custom-objects.get' \
136136
}'
137137
```
138138

139-
### List Custom Objects
139+
### List custom objects
140140

141141
To list custom objects, use the `custom-objects.list` endpoint:
142142

@@ -155,7 +155,7 @@ curl --location 'https://api.devrev.ai/custom-objects.list' \
155155
}'
156156
```
157157

158-
### Update a Custom Object
158+
### Update a custom object
159159

160160
To update an existing custom object, use the `custom-objects.update` endpoint.
161161
The following example updates the budget of the previously created campaign custom object:
@@ -173,7 +173,7 @@ curl --location 'https://api.devrev.ai/custom-objects.update' \
173173
}'
174174
```
175175

176-
### Delete a Custom Object
176+
### Delete a custom object
177177

178178
To delete a custom object, use the `custom-objects.delete` endpoint.
179179
The following example deletes the previously created campaign custom object:
@@ -188,7 +188,7 @@ curl --location 'https://api.devrev.ai/custom-objects.delete' \
188188
}'
189189
```
190190

191-
## Key Concepts
191+
## Key concepts
192192

193193
1. **Leaf Type**: The base type of your custom object (e.g., "campaign").
194194
2. **Subtype**: A more specific categorization within a leaf type (e.g., "promotion" or "advertising" for a "campaign" leaf type).
@@ -197,7 +197,7 @@ curl --location 'https://api.devrev.ai/custom-objects.delete' \
197197

198198
For more details on customization concepts, please refer to the [Customization](./object-customization) documentation.
199199

200-
## Custom Object Lifecycle
200+
## Custom object lifecycle
201201

202202
1. **Creation**: Define the leaf type, subtype (optional), and custom fields for your custom object.
203203
2. **Usage**: Create, update, and query custom objects as needed in your workflows.

0 commit comments

Comments
 (0)