PATCH/v1/cards/{card_id}

Opdatér et kort

update_card

Autentificering

Send en API-nøgle i headeren Authorization: Authorization: Bearer <nøgle>.

Stiparametre

card_idstringpåkrævet

Headerparametre

Idempotency-Keystring
Nøgle til et sikkert nyt forsøg på en skrivning: 1 til 255 printbare ASCII-tegn; en UUID v4 pr. logisk operation anbefales. Et nyt forsøg med samme nøgle inden for 24 timer udfører ikke operationen igen: det returnerer det gemte svar (status, headere og brødtekst) med headeren Idempotency-Replayed: true. Samme nøgle med en anden metode, sti, Content-Type eller brødtekst returnerer 409 api.idempotency_mismatch; mens den første anmodning stadig kører, 409 api.idempotency_in_progress med Retry-After: 1. Efter et 5xx- eller 429-svar frigives nøglen, og et nyt forsøg udfører operationen igen. Nøglen gælder for organisationen og den kaldende part (API-nøgle, bruger eller nøgle til en brugerdefineret kilde).
length ≥ 1, length ≤ 255
X-View-Asstring
Kun for API-nøgler med rollen admin. Udfører anmodningen som dataprofilen <profile>[:viewer|verifier|editor], fx employee:viewer. Installationsnøglen kan ikke bruge denne header (403).

Cookieparametre

kb_view_asstring
Cookie for tilstanden »View as« i en session. POST /auth/view-as sætter den, og DELETE /auth/view-as fjerner den.

Anmodningens brødtekst

application/json

Objekt: CardUpdate

external_idstring | null
Angiver eller ændrer kortets external_id; "" eller null fjerner det. Bruger et andet kort i organisationen det, returnerer anmodningen 409 cards.external_id_taken. external_id for et kort fra en kilde ændres ikke (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

200Vellykket svar

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.
Idempotency-Replayed
true betyder, at svaret blev afspillet igen fra det gemte svar for denne Idempotency-Key: operationen blev ikke udført igen.

application/json

Objekt: Card

expandedCardExpanded
permissionsObjectPermissionList
accessstring
Tilladte værdier: wholepartial
access_contactstring
Hvem der skal kontaktes for at få adgang (kun når access=partial).
aclobject
Felter
- verifybooleanpåkrævet
- writebooleanpåkrævet
categorystringpåkrævet
category_confidencenumber | nullpåkrævet
category_lockedbooleanpåkrævet
category_reviewbooleanpåkrævet
category_sourceCategorySource | nullpåkrævet
collectionstringpåkrævet
collection_idintegerpåkrævet
collection_titlestring
commentsarray of CardComment
content_jsonContentJSON | null
Editorindhold for den seneste publicerede version. Feltet kan mangle; hent i så fald editorindholdet fra et udkast (POST /v1/drafts med card_id).
editing_lockEditingLock | null
Aktiv redigeringslås. Feltet kan mangle; i så fald får editoren at vide, hvem der har låsen, fra 409 cards.locked på POST /v1/cards/{card_id}/lock.
created_atstring (date-time)påkrævet
days_since_verifiedintegerpåkrævet
errorstring | nullpåkrævet
eventsarray of CardEvent
feedback_negintegerpåkrævet
feedback_posintegerpåkrævet
foldersarray of CardFolderRef
Kun i kortlisten: de mapper, der indeholder kortet (dem, brugeren kan se), med deres stier fra samlingens rod. En tom liste betyder, at kortet ikke ligger i nogen mappe.
has_tablesboolean
Kun i kortlisten.
hidden_partsboolean
idstringpåkrævet
jobJob | null
kindCardKindpåkrævet
org_idintegerpåkrævet
owner_activeboolean | null
owner_idinteger | nullpåkrævet
owner_namestring | nullpåkrævet
pagesinteger | nullpåkrævet
parserstring | nullpåkrævet
Dokumentparser som neutral kode: document (fuld struktur: sider, overskrifter, tabeller, scannede sider), pdf (PDF’ens tekstlag), docx, xlsx, csv, markdown, html, text. Listen kan blive udvidet.
partsarray of CardPartpåkrævet
sensitivebooleanpåkrævet
sha256string | nullpåkrævet
sizeintegerpåkrævet
snoozed_atstring (date-time) | null
snoozed_byinteger | null
snoozed_untilstring | null
source_changedbooleanpåkrævet
source_pathstring | nullpåkrævet
source_urlstring | nullpåkrævet
statusstringpåkrævet
Tilladte værdier: processingreadyerrorarchived
tablesarray of CardTable
tagsarray of stringpåkrævet
titlestringpåkrævet
trustnumberpåkrævet
trust_if_verifiednumber
trust_partsTrustPartspåkrævet
updated_atstring (date-time)påkrævet
verificationVerificationpåkrævet
verified_atstring (date-time) | nullpåkrævet
verified_byinteger | nullpåkrævet
verified_by_namestring | null
verifier_idsarray of integerpåkrævet
verifiersarray of object
Felter
- activebooleanpåkrævet
- idintegerpåkrævet
- namestringpåkrævet
verify_interval_daysintegerpåkrævet
versionintegerpåkrævet
versionsarray of CardVersion
source_archiveArchiveSource
created_byinteger | null
manual_optionsobject
Manuelle indstillinger for parsing (forhåndsvisning).
doc_kindDocKind | null
Dokumenttype. null, hvis typen ikke er bestemt (fx for kort, der blev indekseret, før dokumenttyper blev indført).
doc_kind_confidencenumber | null
Konfidens for dokumenttypen, fra 0 til 1.
doc_kind_sourcestring | null
Hvad der bestemte typen: regler (rules), en bruger (manual) eller automatisk klassificering. Listen kan blive udvidet: behandl en ukendt værdi som automatisk klassificering.
Tilladte værdier: rulesmanualnull
invoiceDocInvoiceExtraction | null
Felter i en faktura, kreditnota eller kvittering (kun for disse typer og kun i kortet, ikke i listen). null, hvis du ikke har adgang til hele dokumentet, fordi felterne udtrækkes fra hele dokumentet.
warningsarray of ReviewWarning
Advarsler fra parsing af dokumentet (ReviewWarning; kun i kortet, ikke i listen).
enrichmentCardEnrichmentStatus | null
Status for berigelse (kun i kortet, ikke i listen). Dokumenttypen, fakturafelterne og de økonomiske poster tilføjes i baggrunden efter indekseringen og kan genberegnes senere; de vises i kortet, når de er klar. null betyder, at der ikke findes nogen status (kortet blev indekseret uden berigelse i baggrunden).
external_idstring | null
Kortets id i integratorens system. Det er entydigt i organisationen blandt kort, der ikke kommer fra kilder; null betyder, at det ikke er angivet. /v1/cards-by-external-id/{external_id} læser og erstatter kortet efter det.
length ≤ 512
metadataMetadata

400Anmodningen er ugyldig: en parameterværdi eller objektets tilstand tillader ikke handlingen (`detail` er en meddelelse).

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

401Der blev ikke sendt legitimationsoplysninger (hverken en sessionscookie eller en API-nøgle), eller nøglen blev ikke fundet.

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

403Handlingen er ikke tilladt: rollen er utilstrækkelig, der er ingen adgang til samlingen eller kortet, anmodningen kører i tilstanden »View as«, eller organisationen er suspenderet eller slettet (`detail` er et objekt med `code: org_suspended | org_deleted`).

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

404Objektet findes ikke eller er ikke tilgængeligt for dig. API’et bekræfter ikke, at et begrænset objekt findes.

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

422Valideringsfejl: brødteksten eller parametrene svarer ikke til skemaet (`detail` er en liste over valideringsfejl), eller en parameterværdi ligger uden for det tilladte interval (`detail` er en meddelelse).

Svarets headere

RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

429For mange anmodninger (`api.rate_limited`), organisationens kvote for minuttet, dagen eller måneden er brugt op (`api.quota_exceeded`; `error.details` indeholder `quota`, `limit` og `reset_at`), organisationens grænse er nået, eller svartjenesten er optaget (`answers.engine_busy`). Vent den tid, der står i headeren `Retry-After`.

Svarets headere

Retry-After
Antal sekunder, du skal vente, før du prøver anmodningen igen.
RateLimit-Policy
Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.
RateLimit
Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).
X-RateLimit-Remaining
Resterende anmodninger under den strengeste grænse.
X-RateLimit-Reset
Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

Fejlkoder

Koder, som denne operation kan returnere i error.code, ud over de generelle koder for alle anmodninger.

Sikre nye forsøg

Send en Idempotency-Key-header (fx et UUID) med hver POST og PATCH. Et nyt forsøg med den samme nøgle inden for 24 timer returnerer det gemte svar i stedet for at køre anmodningen igen.

Hastighedsgrænser

Svarene har headerne RateLimit og RateLimit-Policy samt de tidligere X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og forsøg igen.

← cards · API-reference

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"

Afprøv

API-nøgle

Nøglen gemmes kun i denne fanes hukommelse og sendes kun til https://api.sursa.com.

Anmodningerne udføres på din organisations rigtige data.

Idempotency-Key header

X-View-As header

card_id path *

Idempotency-Key

Er feltet tomt, genereres en ny nøgle for hver anmodning.

Anmodningens brødtekst (JSON)