Link Search Menu Expand Document
noice.link Documentation

Register a URL

POST https://noice.link/api/url
Creates a new short URL\

Required payload parameters:

  • url (string): The unshortified URL

Optional payload parameters:

  • slug (string): A custom slug
  • title (string): The preview’s title
  • description (string): The preview’s description
  • image (string): The preview’s image
  • color (string): The embed color in HEX format (e.g.: “#ff00ff”)

Example payload: 

{
    description: "poggers",
    image: "https://cdn.macedon.ga/image.png"
    slug: "free-nitro",
    title: "Yes free nitro",
    url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    color: "#ffffff"
}

cURL request example 

curl --request POST \
 --url https://noice.link/api/url \
 --header 'Authorization: YOUR_LINK_TOKEN' \
 --header 'Content-Type: application/json'
 --data '{"url": "https://macedon.ga"}'

Example response: 

{
    description: "poggers",
    image: "https://cdn.macedon.ga/image.png",
    slug: "qixof",
    title: "Yes free nitro",
    url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    token: "eyASNOnjds...",
    color: "#ffffff"
}

Possible error codes:

Here