Create relations
Bulk-creates relations. Successful entities are returned in data; per-item failures in errors keyed by title.
POST
/api/v2/{team_slug}/{app_slug}/relationsAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonrelationsCreateRelationItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
CreateRelationItemtitlestringrequiredtype_idUUIDrequireddirectionstringAllowed:
one_waytwo_wayprimary_product_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullResponses
201
Created (partial success possible)
dataRelation[]requiredShow propertiesHide properties
Array of
RelationidUUIDrequiredtitlestringrequiredtypestringrequiredtype_idUUIDrequireddirectionstringrequiredprimary_product_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullproductsRelationProduct[] | nullShow propertiesHide properties
Array of
RelationProductidstringrequiredproduct_namestringdescriptionstringproduct_numberstringslugstringimage_urlstring | nullerrorsRelationError[]requiredShow propertiesHide properties
Array of
RelationErrortitlestringidUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullmessagestringrequired400
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required401
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required403
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required500
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required