Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.
Matthias Rohmer edited this page Sep 30, 2021 · 1 revision

The API's main entities allow links to be added to them. Links are not further described URLs to other resources on the web, also meaning they don't come with an alternative text or any kind of sorting.

Resource

interface Link {
  id: number;
  type: "link";
  attributes: {
    url: string;
  };
}

Add a link to a resource

To add a link to another resource you can send a list of URLs with any POST or PATCH request to any of the main resource routes. For example to add links to an already existing organizer with the ID cku5dqtqj00001lgl4w8ga9z6 send a PATCH request to /v1/organizer/cku5dqtqj00001lgl4w8ga9z6 with the following body:

{
  "links": ["https://cool-organizer.com", "https://charity.org"]
}

Important: this operation is destructive and replaces potentially already existing links, make sure you resend links you want to keep.

Clone this wiki locally