Skip to main content
PUT
/
articles
/
{id}
/
relations
Set related articles (bulk)
curl --request PUT \
  --url https://api.awardee.dev/v1/articles/{id}/relations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "related_article_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "mode": "replace"
}
'
{
  "object": "<string>",
  "total": 0,
  "page": 0,
  "page_size": 0,
  "data": [
    {
      "object": "<string>",
      "article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related_article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related_title": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
related_article_ids
string<uuid>[]
required

Related article UUIDs (forward direction only).

Maximum array length: 100
​
mode
enum<string>
default:replace

replace: article ends up linked to exactly this set (omitted links removed). add: only adds these, never removes existing links.

Available options:
replace,
add

Response

Relations after the operation

​
object
string
required
Allowed value: "list"
​
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
page_size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
data
object[]
required