PATCH/v1/cards/{card_id}

Uppdatera ett kort

update_card

Autentisering

Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.

Sökvägsparametrar

card_idstringobligatorisk

Parametrar i huvuden

Idempotency-Keystring
Nyckel för ett säkert nytt försök med en skrivning: 1–255 utskrivbara ASCII-tecken; ett UUID v4 per logisk åtgärd rekommenderas. Ett nytt försök med samma nyckel inom 24 timmar kör inte åtgärden igen, utan returnerar det sparade svaret (status, huvuden och brödtext) med huvudet Idempotency-Replayed: true. Samma nyckel med en annan metod, sökväg, Content-Type eller brödtext returnerar 409 api.idempotency_mismatch; medan det första anropet fortfarande pågår returneras 409 api.idempotency_in_progress med Retry-After: 1. Efter ett 5xx- eller 429-svar frigörs nyckeln, och ett nytt försök kör åtgärden igen. Nyckeln gäller inom organisationen och för anroparen (API-nyckel, användare eller källnyckel för en egen källa).
length ≥ 1, length ≤ 255
X-View-Asstring
Bara för API-nycklar med rollen admin. Gör anropet som dataprofilen <profile>[:viewer|verifier|editor], till exempel employee:viewer. Installationsnyckeln kan inte använda det här huvudet (403).

Cookie-parametrar

kb_view_asstring
Cookie för läget ”View as” (visa som en annan användare) i en session. POST /auth/view-as sätter den och DELETE /auth/view-as tar bort den.

Anropets brödtext

application/json

Objekt: CardUpdate

external_idstring | null
Anger eller ändrar kortets external_id; "" eller null tar bort det. Om ett annat kort i organisationen använder det returnerar anropet 409 cards.external_id_taken. external_id för ett källkort ändras inte (409 cards.managed_by_source).
length ≤ 512
metadataMetadataPatch
titlestring | null
owner_idinteger | null
verifier_idsarray of integer | null
verify_interval_daysinteger | null
≥ 1, ≤ 3650
tagsarray of string | null
statusstring | null
source_urlstring | null
categorystring | null
sensitiveboolean | null
table_categoriesmap of object | null

Svar

200Lyckat svar

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.
Idempotency-Replayed
true betyder att svaret spelades upp från det sparade svaret för denna Idempotency-Key: åtgärden kördes inte igen.

application/json

Objekt: Card

expandedCardExpanded
permissionsObjectPermissionList
accessstring
Tillåtna värden: wholepartial
access_contactstring
Vem man kontaktar för åtkomst (bara när access=partial).
aclobject
Fält
- verifybooleanobligatorisk
- writebooleanobligatorisk
categorystringobligatorisk
category_confidencenumber | nullobligatorisk
category_lockedbooleanobligatorisk
category_reviewbooleanobligatorisk
category_sourceCategorySource | nullobligatorisk
collectionstringobligatorisk
collection_idintegerobligatorisk
collection_titlestring
commentsarray of CardComment
content_jsonContentJSON | null
Innehåll för textredigeraren i den senaste publicerade versionen. Fältet kan saknas; hämta i så fall redigerarens innehåll från ett utkast (POST /v1/drafts med card_id).
editing_lockEditingLock | null
Aktivt redigeringslås. Fältet kan saknas; i så fall får den som redigerar veta vem som har låset genom 409 cards.locked på POST /v1/cards/{card_id}/lock.
created_atstring (date-time)obligatorisk
days_since_verifiedintegerobligatorisk
errorstring | nullobligatorisk
eventsarray of CardEvent
feedback_negintegerobligatorisk
feedback_posintegerobligatorisk
foldersarray of CardFolderRef
Bara i kortlistan: mapparna som innehåller kortet (de som användaren ser), med sina sökvägar från samlingens rotnivå. En tom lista betyder att kortet inte ligger i någon mapp.
has_tablesboolean
Bara i kortlistan.
hidden_partsboolean
idstringobligatorisk
jobJob | null
kindCardKindobligatorisk
org_idintegerobligatorisk
owner_activeboolean | null
owner_idinteger | nullobligatorisk
owner_namestring | nullobligatorisk
pagesinteger | nullobligatorisk
parserstring | nullobligatorisk
Dokumentets tolk som neutral kod: document (fullständig struktur: sidor, rubriker, tabeller, skannade sidor), pdf (PDF-filens textlager), docx, xlsx, csv, markdown, html, text. Listan kan utökas.
partsarray of CardPartobligatorisk
sensitivebooleanobligatorisk
sha256string | nullobligatorisk
sizeintegerobligatorisk
snoozed_atstring (date-time) | null
snoozed_byinteger | null
snoozed_untilstring | null
source_changedbooleanobligatorisk
source_pathstring | nullobligatorisk
source_urlstring | nullobligatorisk
statusstringobligatorisk
Tillåtna värden: processingreadyerrorarchived
tablesarray of CardTable
tagsarray of stringobligatorisk
titlestringobligatorisk
trustnumberobligatorisk
trust_if_verifiednumber
trust_partsTrustPartsobligatorisk
updated_atstring (date-time)obligatorisk
verificationVerificationobligatorisk
verified_atstring (date-time) | nullobligatorisk
verified_byinteger | nullobligatorisk
verified_by_namestring | null
verifier_idsarray of integerobligatorisk
verifiersarray of object
Fält
- activebooleanobligatorisk
- idintegerobligatorisk
- namestringobligatorisk
verify_interval_daysintegerobligatorisk
versionintegerobligatorisk
versionsarray of CardVersion
source_archiveArchiveSource
created_byinteger | null
manual_optionsobject
Manuella inställningar för tolkningen (förhandsvisning).
doc_kindDocKind | null
Dokumenttyp. null om typen inte har fastställts (till exempel för kort som indexerades innan dokumenttyper infördes).
doc_kind_confidencenumber | null
Konfidens för dokumenttypen, från 0 till 1.
doc_kind_sourcestring | null
Vad som avgjorde typen: regler (rules), en användare (manual) eller automatisk klassificering. Listan kan utökas: behandla ett okänt värde som automatisk klassificering.
Tillåtna värden: rulesmanualnull
invoiceDocInvoiceExtraction | null
Fält för en faktura, kreditfaktura eller ett kvitto (bara för dessa typer och bara i kortet, inte i listan). null om du inte har åtkomst till hela dokumentet, eftersom fälten hämtas ur hela dokumentet.
warningsarray of ReviewWarning
Varningar från tolkningen av dokumentet (ReviewWarning; bara i kortet, inte i listan).
enrichmentCardEnrichmentStatus | null
Berikningsstatus (bara i kortet, inte i listan). Dokumenttypen, fakturafälten och de finansiella posterna läggs till i bakgrunden efter indexeringen och kan räknas om senare; de visas i kortet när de är klara. null betyder att ingen status finns (kortet indexerades utan berikning i bakgrunden).
external_idstring | null
Kortets id i integratörens system. Det är unikt i organisationen bland kort som inte kommer från källor; null betyder att det inte är angivet. /v1/cards-by-external-id/{external_id} läser och ersätter kortet med hjälp av det.
length ≤ 512
metadataMetadata

400Anropet är ogiltigt: ett parametervärde eller objektets tillstånd tillåter inte åtgärden (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

401Inga autentiseringsuppgifter skickades (varken en sessionscookie eller en API-nyckel), eller så hittades inte nyckeln.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

403Åtgärden är inte tillåten: rollen räcker inte, det saknas åtkomst till samlingen eller kortet, anropet körs i läget ”View as” (visa som en annan användare), eller organisationen är avstängd eller borttagen (`detail` är ett objekt med `code: org_suspended | org_deleted`).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

404Objektet finns inte eller är inte tillgängligt för dig. API:et bekräftar inte att ett begränsat objekt finns.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

422Valideringsfel: brödtexten eller parametrarna stämmer inte med schemat (`detail` är en lista med valideringsfel), eller så ligger ett parametervärde utanför det tillåtna intervallet (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

429För många anrop (`api.rate_limited`), organisationens kvot för minuten, dygnet eller månaden är förbrukad (`api.quota_exceeded`; `error.details` innehåller `quota`, `limit` och `reset_at`), organisationens gräns är nådd eller svarstjänsten är upptagen (`answers.engine_busy`). Vänta den tid som anges i huvudet `Retry-After`.

Svarshuvuden

Retry-After
Antal sekunder att vänta innan du skickar anropet igen.
RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

Felkoder

Koder som den här slutpunkten kan returnera i error.code, utöver de allmänna koderna för alla anrop.

Säkra nya försök

Skicka huvudet Idempotency-Key (till exempel ett UUID) med varje POST och PATCH. Ett nytt försök med samma nyckel inom 24 timmar returnerar det sparade svaret i stället för att köra anropet igen.

Hastighetsbegränsningar

Svaren innehåller huvudena RateLimit och RateLimit-Policy samt de tidigare X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Ett 429-svar har Retry-After i sekunder: vänta och försök igen.

← cards · API-referens

curl -X PATCH 'https://api.sursa.com/v1/cards/CARD_ID' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"external_id":"crm-1042","metadata":{"key":"string"},"title":"Refund policy"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Prova

API-nyckel

Nyckeln finns bara i den här flikens minne och skickas bara till https://api.sursa.com.

Anropen påverkar din organisations riktiga data.

Idempotency-Key header

X-View-As header

card_id path *

Idempotency-Key

Är fältet tomt skapas en ny nyckel för varje anrop.

Anropets brödtext (JSON)