Skip to main content
PUT
/
v1
/
user
/
pins
Update Pins
curl --request PUT \
  --url https://api.supernotes.app/v1/user/pins \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pins": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "mode": "replace"
}
'
import requests

url = "https://api.supernotes.app/v1/user/pins"

payload = {
    "pins": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "mode": "replace"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pins: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], mode: 'replace'})
};

fetch('https://api.supernotes.app/v1/user/pins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.supernotes.app/v1/user/pins",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'pins' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'mode' => 'replace'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.supernotes.app/v1/user/pins"

	payload := strings.NewReader("{\n  \"pins\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"mode\": \"replace\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.supernotes.app/v1/user/pins")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pins\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"mode\": \"replace\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.supernotes.app/v1/user/pins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pins\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"mode\": \"replace\"\n}"

response = http.request(request)
puts response.read_body
[
  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
{
  "type": "<string>",
  "detail": "<string>",
  "status": 123
}

Authorizations

Api-Key
string
header
required

Body

application/json
pins
string<uuid>[]
required
mode
enum<string>
default:replace
Available options:
add,
remove,
replace

Response

Successful Response