Skip to main content
POST
/
api
/
v1
/
:team_slug
/
:app_slug
/
relations
Error
A valid request URL is required to generate request examples
{
  "data": {
    "direction": "<string>",
    "id": "<string>",
    "primary_product_id": "<string>",
    "products": [
      {
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "product_name": "<string>",
        "product_number": "<string>",
        "slug": "<string>"
      }
    ],
    "title": "<string>",
    "type": "<string>",
    "type_id": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Body

application/json

Relation data

​
product_ids
string[]
required
Minimum array length: 1
​
relation_type_id
string
required
​
direction
enum<string>
default:two_way

Default two_way

Available options:
one_way,
two_way
​
primary_product_id
string

Response

Relation created successfully

​
data
object
​
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

​
success
boolean