Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Update relations

Bulk-patches relations by id. Successful entities are returned in data; per-item failures in errors.

PATCH/api/v2/{team_slug}/{app_slug}/relations
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
Request body
requiredapplication/json
relationsPatchRelationItem[]required
min items 1 · max items 20
Show properties
Array of PatchRelationItem
idUUIDrequired
titlestring
type_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
directionstring
Allowed:one_waytwo_way
primary_product_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
Responses
200

Patched (partial success possible)

dataRelation[]required
Show properties
Array of Relation
idUUIDrequired
titlestringrequired
typestringrequired
type_idUUIDrequired
directionstringrequired
primary_product_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
productsRelationProduct[] | null
Show properties
Array of RelationProduct
idstringrequired
product_namestring
descriptionstring
product_numberstring
slugstring
image_urlstring | null
errorsRelationError[]required
Show properties
Array of RelationError
titlestring
idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
messagestringrequired
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH 'https://api.enad.io/api/v2/string/string/relations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "relations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "string",
      "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
      "direction": "one_way",
      "primary_product_id": "7a85a404-d868-4693-9493-c9cd5be375b7"
    }
  ]
}'
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "title": "string",
      "type": "string",
      "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
      "direction": "string",
      "primary_product_id": "7a85a404-d868-4693-9493-c9cd5be375b7",
      "products": [
        {
          "id": "string",
          "product_name": "string",
          "description": "string",
          "product_number": "string",
          "slug": "string",
          "image_url": "string"
        }
      ]
    }
  ],
  "errors": [
    {
      "title": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}