PATCH/v1/folders/{folder_id}

Zmiana nazwy, przeniesienie lub zmiana kolejności folderu

update_folder

Wymaga uprawnienia COLLECTION_EDIT_CARDS do folderu, a przy przeniesieniu także do nowego miejsca (folderu nadrzędnego lub kolekcji w przypadku najwyższego poziomu). parent_id: null przenosi folder na najwyższy poziom kolekcji. prev_sibling_id ustala pozycję wśród elementów równorzędnych nowego (lub bieżącego) folderu nadrzędnego: first, last lub ID elementu równorzędnego. Przeniesienie folderu do jego własnego podfolderu zwraca folders.cycle, a poddrzewo głębsze niż trzy poziomy – folders.depth_exceeded. color i icon ustalają wygląd, a null przywraca wygląd automatyczny; wartość spoza dozwolonej listy zwraca folders.appearance_invalid.

Uwierzytelnianie

Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.

Parametry ścieżki

folder_idstringwymagane

Parametry nagłówka

Idempotency-Keystring
Klucz bezpiecznego ponowienia zapisu: od 1 do 255 drukowalnych znaków ASCII; zalecany jest UUID v4 na każdą operację logiczną. Ponowienie z tym samym kluczem w ciągu 24 godzin nie wykonuje operacji ponownie: zwraca zapisaną odpowiedź (status, nagłówki i treść) z nagłówkiem Idempotency-Replayed: true. Ten sam klucz z inną metodą, ścieżką, Content-Type lub treścią zwraca 409 api.idempotency_mismatch; dopóki pierwsze żądanie jest jeszcze wykonywane – 409 api.idempotency_in_progress z Retry-After: 1. Po odpowiedzi 5xx lub 429 klucz zostaje zwolniony, a ponowienie wykonuje operację jeszcze raz. Klucz obowiązuje w obrębie organizacji i wywołującego (klucz API, użytkownik lub klucz własnego źródła).
length ≥ 1, length ≤ 255

Treść żądania

application/json

Obiekt: FolderUpdate

titlestring
length ≥ 1, length ≤ 200
parent_idstring | null
Nowy folder nadrzędny. null przenosi folder na najwyższy poziom kolekcji. Jeśli pola brak, folder nadrzędny się nie zmienia.
prev_sibling_idFolderPosition
colorFolderColor | null
Kolor folderu z palety. null przywraca kolor automatyczny; jeśli pola brak, kolor się nie zmienia.
iconFolderIcon | null
Ikona folderu. null przywraca ikonę automatyczną; jeśli pola brak, ikona się nie zmienia.
metadataMetadataPatch

Odpowiedzi

200Pomyślna odpowiedź

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.
Idempotency-Replayed
true oznacza, że odpowiedź została odtworzona z odpowiedzi zapisanej dla tego Idempotency-Key: operacja nie została wykonana ponownie.

application/json

Obiekt: Folder

idstringwymagane
collection_idintegerwymagane
parent_idstring | nullwymagane
titlestringwymagane
sort_keystringwymagane
created_byinteger | nullwymagane
created_atstring (date-time)wymagane
updated_atstring (date-time)wymagane
colorFolderColor | nullwymagane
Kolor folderu z palety, taki sam dla wszystkich użytkowników. null oznacza kolor automatyczny: klient wybiera kolor z palety na podstawie nazwy.
iconFolderIcon | nullwymagane
Ikona folderu, taka sama dla wszystkich użytkowników. null oznacza ikonę automatyczną, na podstawie top_category węzła drzewa.
permissionsarray of stringwymagane
metadataMetadata

400Żądanie jest nieprawidłowe: wartość parametru lub stan obiektu nie pozwala na to działanie (`detail` zawiera komunikat).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

401Nie przesłano danych uwierzytelniających (ani pliku cookie sesji, ani klucza API) lub nie znaleziono klucza.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

403Działanie jest niedozwolone: rola jest niewystarczająca, brak dostępu do kolekcji lub karty, żądanie jest wykonywane w trybie „View as” albo organizacja jest zawieszona lub usunięta (`detail` to obiekt z `code: org_suspended | org_deleted`).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

404Obiekt nie istnieje lub nie jest dla Ciebie dostępny. API nie potwierdza istnienia obiektu z ograniczonym dostępem.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

409Stan obiektu nie pozwala na to działanie, np. duplikat, trwające indeksowanie lub zadanie, które zostało już przetworzone.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

422Błąd walidacji: treść lub parametry nie odpowiadają schematowi (`detail` to lista błędów walidacji) albo wartość parametru jest poza zakresem (`detail` zawiera komunikat).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

429Zbyt wiele żądań (`api.rate_limited`), wyczerpano przydział organizacji na minutę, dzień lub miesiąc (`api.quota_exceeded`; `error.details` zawiera `quota`, `limit` i `reset_at`), osiągnięto limit organizacji albo usługa odpowiedzi jest zajęta (`answers.engine_busy`). Odczekaj czas podany w nagłówku `Retry-After`.

Nagłówki odpowiedzi

Retry-After
Liczba sekund oczekiwania przed ponowieniem żądania.
RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

Kody błędów

Kody, które ta operacja może zwrócić w error.code, oprócz ogólnych kodów każdego żądania.

Bezpieczne ponawianie

Wysyłaj nagłówek Idempotency-Key (na przykład UUID) z każdym żądaniem POST i PATCH. Ponowienie z tym samym kluczem w ciągu 24 godzin zwraca zapisaną odpowiedź, zamiast ponownie wykonywać żądanie.

Limity częstotliwości

Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.

← folders · Dokumentacja API

curl -X PATCH 'https://api.sursa.com/v1/folders/FOLDER_ID' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy","parent_id":"string","prev_sibling_id":"string"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Wypróbuj

Klucz API

Klucz zostaje w pamięci tej karty przeglądarki i jest wysyłany tylko do https://api.sursa.com.

Żądania działają na prawdziwych danych Twojej organizacji.

Idempotency-Key header

folder_id path *

Idempotency-Key

Gdy to pole jest puste, dla każdego żądania generowany jest nowy klucz.

Treść żądania (JSON)