{"id":444457,"date":"2026-04-03T02:43:15","date_gmt":"2026-04-03T00:43:15","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/rest-api-entity-relationships\/"},"modified":"2026-04-03T02:43:15","modified_gmt":"2026-04-03T00:43:15","password":"","slug":"rest-api-entity-relationships","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/en\/help\/api\/rest-api-entity-relationships\/","title":{"rendered":"REST API – Entity Relationships"},"content":{"rendered":"
\n

Add Related \u2014 Add a relationship<\/h2>\n

This operation allows you to add an item to an entity’s related lists. The related list must be of type get_related_list<\/code> (and not get_dependents_list<\/code>, as the latter are added automatically when the linked entity is created). <\/p>\n

\n

POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n

\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\nyes<\/td>\nMust be add_related<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSession ID<\/td>\n<\/tr>\n
sourceRecordId<\/code><\/td>\nstring<\/td>\nyes<\/td>\nSource entity Webservice ID<\/td>\n<\/tr>\n
relatedLabel<\/code><\/td>\nstring<\/td>\nyes<\/td>\nLinked module name<\/td>\n<\/tr>\n
relatedRecordId<\/code><\/td>\nstring<\/td>\nyes<\/td>\nWebservice ID of the entity to link<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

curl example:<\/strong><\/p>\n

curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d \"operation=add_related\" \\\n  -d \"sessionName=YOUR_SESSION_ID\" \\\n  -d \"sourceRecordId=21x3456\" \\\n  -d \"relatedLabel=Documents\" \\\n  -d \"relatedRecordId=15x7890\"\n<\/code><\/pre>\n
\n
Related references \ud83d\udd17<\/h2>\n