@@ -3,10 +3,11 @@ This feature enables you to define meaningful connections with custom names that
3
3
4
4
This section provides an overview of custom links and walks you through the process of creating and managing them.
5
5
By the end of this section, you'll be able to:
6
- 1 . Create custom link types between different objects
7
- 2 . Update existing custom link types
8
- 3 . Create links between objects using custom link types
9
- 4 . List and filter custom link types
6
+ 1 . Define custom link types
7
+ 2 . Create links between objects
8
+ 3 . List custom link types
9
+ 4 . Update custom link types
10
+ 5 . Deprecate custom link types
10
11
11
12
## Concepts
12
13
@@ -18,10 +19,6 @@ A custom link type defines a relationship between two types of objects. It speci
18
19
- A forward name describing the relationship from source to target
19
20
- A backward name describing the relationship from target to source
20
21
21
- For more details on customization or custom object concepts, please refer to the documentation below:
22
- - [ Customization] ( ./object-customization )
23
- - [ Custom objects] ( ./custom-objects )
24
-
25
22
### Supported object types
26
23
27
24
Custom links can be created between the following object types:
@@ -30,10 +27,9 @@ Custom links can be created between the following object types:
30
27
- account, user
31
28
- part (product, capability, feature, enhancement)
32
29
33
- <Callout intent = " note" >
34
- Custom link types cannot be deleted, only deprecated. This ensures that existing links maintain
35
- referential integrity and prevents data corruption.
36
- </Callout >
30
+ For more details on customization or custom object concepts, please refer to the documentation below:
31
+ - [ Customization] ( ./object-customization )
32
+ - [ Custom objects] ( ./custom-objects )
37
33
38
34
## Create custom link types
39
35
@@ -181,3 +177,21 @@ This configuration:
181
177
<Callout intent = " tip" >
182
178
To add more valid source subtypes, use the update endpoint to add them to the ` source_types ` array.
183
179
</Callout >
180
+
181
+ ## Deprecate custom link types
182
+
183
+ <Callout intent = " note" >
184
+ Custom link types cannot be deleted, only deprecated. This ensures that existing links maintain
185
+ referential integrity and prevents data corruption.
186
+ </Callout >
187
+
188
+ To deprecate a custom link type, use the update endpoint and set ` deprecated ` to ` true ` :
189
+ ``` curl {6}
190
+ curl --location 'https://api.devrev.ai/link-types.custom.update' \
191
+ --header 'Content-Type: application/json' \
192
+ --header 'Authorization: Bearer <TOKEN>' \
193
+ --data '{
194
+ "id": "don:core:dvrv-us-1:devo/demo:custom_link_type/1",
195
+ "deprecated": true
196
+ }'
197
+ ```
0 commit comments