PATCH/v1/cards/{card_id}

Oppdater et kort

update_card

Autentisering

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

Baneparametere

card_idstringobligatorisk

Headerparametere

Idempotency-Keystring
Nøkkel for et trygt nytt forsøk på en skriveoperasjon: 1 til 255 utskrivbare ASCII-tegn; en UUID v4 per logisk operasjon anbefales. Et nytt forsøk med samme nøkkel innen 24 timer kjører ikke operasjonen på nytt: det returnerer det lagrede svaret (status, headere og brødtekst) med headeren Idempotency-Replayed: true. Samme nøkkel med en annen metode, bane, Content-Type eller brødtekst returnerer 409 api.idempotency_mismatch; mens den første forespørselen fortsatt kjører, 409 api.idempotency_in_progress med Retry-After: 1. Etter et 5xx- eller 429-svar frigjøres nøkkelen, og et nytt forsøk kjører operasjonen på nytt. Nøkkelen gjelder per organisasjon og per kaller (API-nøkkel, bruker eller nøkkel for en egendefinert kilde).
length ≥ 1, length ≤ 255
X-View-Asstring
Bare for API-nøkler med rollen admin. Utfører forespørselen som dataprofilen <profile>[:viewer|verifier|editor], for eksempel employee:viewer. Installasjonsnøkkelen kan ikke bruke denne headeren (403).

Parametere i informasjonskapsler

kb_view_asstring
Informasjonskapsel for modusen «View as» (vis som) i en økt. POST /auth/view-as setter den, og DELETE /auth/view-as fjerner den.

Forespørselens brødtekst

application/json

Objekt: CardUpdate

external_idstring | null
Angir eller endrer kortets external_id; "" eller null fjerner den. Bruker et annet kort i organisasjonen den, returnerer forespørselen 409 cards.external_id_taken. external_id for et kort fra en kilde endres 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

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.
Idempotency-Replayed
true betyr at svaret ble gjentatt fra det lagrede svaret for denne Idempotency-Key: operasjonen ble ikke kjørt på nytt.

application/json

Objekt: Card

expandedCardExpanded
permissionsObjectPermissionList
accessstring
Tillatte verdier: wholepartial
access_contactstring
Hvem man kontakter for å få tilgang (bare når access=partial).
aclobject
Felt
- verifybooleanobligatorisk
- writebooleanobligatorisk
categorystringobligatorisk
category_confidencenumber | nullobligatorisk
category_lockedbooleanobligatorisk
category_reviewbooleanobligatorisk
category_sourceCategorySource | nullobligatorisk
collectionstringobligatorisk
collection_idintegerobligatorisk
collection_titlestring
commentsarray of CardComment
content_jsonContentJSON | null
Redigeringsinnholdet i den sist publiserte versjonen. Feltet kan mangle; hent da redigeringsinnholdet fra et utkast (POST /v1/drafts med card_id).
editing_lockEditingLock | null
Aktiv redigeringslås. Feltet kan mangle; da får redigeringsprogrammet vite hvem som har låsen, fra 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
Bare i kortlisten: mappene som inneholder kortet (de brukeren kan se), med stiene fra samlingens rot. En tom liste betyr at kortet ikke ligger i noen mappe.
has_tablesboolean
Bare i kortlisten.
hidden_partsboolean
idstringobligatorisk
jobJob | null
kindCardKindobligatorisk
org_idintegerobligatorisk
owner_activeboolean | null
owner_idinteger | nullobligatorisk
owner_namestring | nullobligatorisk
pagesinteger | nullobligatorisk
parserstring | nullobligatorisk
Dokumenttolkeren som en nøytral kode: document (full struktur: sider, overskrifter, tabeller, skannede sider), pdf (PDF-ens tekstlag), docx, xlsx, csv, markdown, html, text. Listen kan utvides.
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
Tillatte verdier: 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
Felt
- activebooleanobligatorisk
- idintegerobligatorisk
- namestringobligatorisk
verify_interval_daysintegerobligatorisk
versionintegerobligatorisk
versionsarray of CardVersion
source_archiveArchiveSource
created_byinteger | null
manual_optionsobject
Manuelle innstillinger for tolkingen (forhåndsvisning).
doc_kindDocKind | null
Dokumenttype. null hvis typen ikke er fastslått (for eksempel for kort som ble indeksert før dokumenttyper ble innført).
doc_kind_confidencenumber | null
Konfidens for dokumenttypen, fra 0 til 1.
doc_kind_sourcestring | null
Hva som fastslo typen: regler (rules), en bruker (manual) eller automatisk klassifisering. Listen kan utvides: behandle en ukjent verdi som automatisk klassifisering.
Tillatte verdier: rulesmanualnull
invoiceDocInvoiceExtraction | null
Feltene i en faktura, en kreditnota eller en kvittering (bare for disse typene, og bare i kortet, ikke i listen). null hvis du ikke har tilgang til hele dokumentet, fordi feltene hentes ut fra hele dokumentet.
warningsarray of ReviewWarning
Advarsler fra tolkingen av dokumentet (ReviewWarning; bare i kortet, ikke i listen).
enrichmentCardEnrichmentStatus | null
Status for berikelsen (bare i kortet, ikke i listen). Dokumenttypen, fakturafeltene og de økonomiske postene legges til i bakgrunnen etter indekseringen og kan beregnes på nytt senere; de vises i kortet når de er klare. null betyr at ingen status er tilgjengelig (kortet ble indeksert uten berikelse i bakgrunnen).
external_idstring | null
Kortets ID i integratorens system. Den er unik i organisasjonen blant kort som ikke kommer fra kilder; null betyr at den ikke er angitt. /v1/cards-by-external-id/{external_id} leser og erstatter kortet etter den.
length ≤ 512
metadataMetadata

400Forespørselen er ugyldig: en parameterverdi eller objektets tilstand tillater ikke handlingen (`detail` er en melding).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

401Ingen påloggingsinformasjon ble sendt (verken øktinformasjonskapsel eller API-nøkkel), eller nøkkelen ble ikke funnet.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

403Handlingen er ikke tillatt: rollen er utilstrekkelig, det finnes ingen tilgang til samlingen eller kortet, forespørselen kjører i modusen «View as», eller organisasjonen er suspendert eller slettet (`detail` er et objekt med `code: org_suspended | org_deleted`).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

404Objektet finnes ikke eller er ikke tilgjengelig for deg. API-et bekrefter ikke at et objekt med begrenset tilgang finnes.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

422Valideringsfeil: brødteksten eller parameterne samsvarer ikke med skjemaet (`detail` er en liste over valideringsfeil), eller en parameterverdi er utenfor tillatt område (`detail` er en melding).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

429For mange forespørsler (`api.rate_limited`), organisasjonens kvote for minuttet, døgnet eller måneden er brukt opp (`api.quota_exceeded`; `error.details` inneholder `quota`, `limit` og `reset_at`), organisasjonens grense er nådd, eller svartjenesten er opptatt (`answers.engine_busy`). Vent så lenge som headeren `Retry-After` angir.

Headere i svaret

Retry-After
Antall sekunder du skal vente før du prøver forespørselen på nytt.
RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

Feilkoder

Kodene denne operasjonen kan returnere i error.code, i tillegg til de generelle kodene for alle forespørsler.

Trygge nye forsøk

Send en Idempotency-Key-header (for eksempel en UUID) med hver POST og PATCH. Et nytt forsøk med samme nøkkel innen 24 timer returnerer det lagrede svaret i stedet for å kjøre forespørselen på nytt.

Hastighetsgrenser

Svarene har headerne RateLimit og RateLimit-Policy og de eldre X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og prøv på nytt.

← cards · API-referanse

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"

Prøv

API-nøkkel

Nøkkelen lagres bare i minnet til denne fanen og sendes bare til https://api.sursa.com.

Forespørslene utføres på de faktiske dataene i organisasjonen din.

Idempotency-Key header

X-View-As header

card_id path *

Idempotency-Key

Når feltet er tomt, genereres en ny nøkkel for hver forespørsel.

Forespørselens brødtekst (JSON)