Create Link

POST

Creates a link between two objects to indicate a relationship.

Request

This endpoint expects an object.

link_typeenumRequired

Type of link used to define the relationship.

sourcestringRequiredformat: "id"

The ID of the source object.

targetstringRequiredformat: "id"

The ID of the target object.

custom_link_typestringOptionalformat: "id"

The ID of the custom link type.

Response

The response to creating a new link.

linkobject

Errors

POST

1 curl -X POST https://api.devrev.ai/links.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "link_type": "custom_link",
6   "source": "foo",
7   "target": "foo"
8 }'

201linksCreateExample

1 {
2   "link": {
3     "id": "foo",
4     "link_type": "custom_link",
5     "source": {
6       "display_id": "foo",
7       "id": "foo",
8       "display_name": "foo"
9     },
10     "target": {
11       "display_id": "foo",
12       "id": "foo",
13       "display_name": "foo"
14     },
15     "created_by": {
16       "display_id": "foo",
17       "id": "foo",
18       "display_name": "foo",
19       "display_picture": {
20         "display_id": "foo",
21         "id": "foo",
22         "file": {
23           "type": "foo",
24           "name": "foo",
25           "size": 42
26         }
27       },
28       "email": "foo",
29       "full_name": "foo",
30       "state": "active"
31     },
32     "created_date": "2023-01-01T12:00:00.000Z",
33     "custom_link_type": {
34       "id": "foo",
35       "display_id": "foo"
36     },
37     "display_id": "foo",
38     "modified_by": {
39       "display_id": "foo",
40       "id": "foo",
41       "display_name": "foo",
42       "display_picture": {
43         "display_id": "foo",
44         "id": "foo",
45         "file": {
46           "type": "foo",
47           "name": "foo",
48           "size": 42
49         }
50       },
51       "email": "foo",
52       "full_name": "foo",
53       "state": "active"
54     },
55     "modified_date": "2023-01-01T12:00:00.000Z"
56   }
57 }

Delete Link

Up Next

Built with

1	curl -X POST https://api.devrev.ai/links.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"link_type": "custom_link",
6	"source": "foo",
7	"target": "foo"
8	}'

1	{
2	"link": {
3	"id": "foo",
4	"link_type": "custom_link",
5	"source": {
6	"display_id": "foo",
7	"id": "foo",
8	"display_name": "foo"
9	},
10	"target": {
11	"display_id": "foo",
12	"id": "foo",
13	"display_name": "foo"
14	},
15	"created_by": {
16	"display_id": "foo",
17	"id": "foo",
18	"display_name": "foo",
19	"display_picture": {
20	"display_id": "foo",
21	"id": "foo",
22	"file": {
23	"type": "foo",
24	"name": "foo",
25	"size": 42
26	}
27	},
28	"email": "foo",
29	"full_name": "foo",
30	"state": "active"
31	},
32	"created_date": "2023-01-01T12:00:00.000Z",
33	"custom_link_type": {
34	"id": "foo",
35	"display_id": "foo"
36	},
37	"display_id": "foo",
38	"modified_by": {
39	"display_id": "foo",
40	"id": "foo",
41	"display_name": "foo",
42	"display_picture": {
43	"display_id": "foo",
44	"id": "foo",
45	"file": {
46	"type": "foo",
47	"name": "foo",
48	"size": 42
49	}
50	},
51	"email": "foo",
52	"full_name": "foo",
53	"state": "active"
54	},
55	"modified_date": "2023-01-01T12:00:00.000Z"
56	}
57	}