Skip to main content
Importer une note de suivi externe

Authorizations

Authorization
string
header
required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID
string

Partner-generated correlation identifier echoed in logs and error payloads.

Idempotency-Key
string
required

Required for every write, including environments where replay deduplication is disabled. Reuse the same value when retrying the same logical write and use a new value for a different write.

Maximum string length: 255
Pattern: ^[!-~]+$

Path Parameters

operation_external_id
string
required

Identifiant externe de l'opération, appartenant à la même intégration.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_~-][A-Za-z0-9._:~-]{0,254}$
note_external_id
string
required

Paramètre note_external_id pour cette route; type, format et contraintes ci-dessous.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_~-][A-Za-z0-9._:~-]{0,254}$

Body

application/json

Note historique. text ou description_i18n non vide est requis. Dates source avec fuseau horaire; source_updated_at ne peut pas précéder source_created_at. Voir Imports et notes pour les règles de traduction et de version.

text
string
required

Texte de la note ou du commentaire.

Required string length: 1 - 10000
date
required

Date métier avec fuseau horaire, ou date YYYY-MM-DD normalisée à minuit UTC.

category
string
default:libre

Catégorie de la note; les règles exactes dépendent de la route. Pour l'import externe: chaîne de 1 à 80 caractères, libre par défaut.

Required string length: 1 - 80
description_i18n
object | null

Au plus 20 locales et 100 000 caractères au total. Locales normalisées en minuscules avec tirets, max 35 caractères; aucune collision après normalisation. Les textes vides sont refusés.

source_created_at
string<date-time> | null

Date de création dans le système source, avec fuseau horaire.

source_updated_at
string<date-time> | null

Date de dernière mise à jour dans le système source, avec fuseau horaire. Pour une note déjà versionnée, un changement exige une date strictement plus récente.

existing_marko_id
string<uuid> | null

UUID d'une ressource MARKO existante à associer lors du premier upsert externe; la cible doit être accessible et compatible.

Response

Additional successful response

external_id
string
required

Identifiant stable de votre système, dans le contexte de votre intégration.

marko_id
string<uuid>
required

Identifiant MARKO résolu ou créé; conservez-le pour les appels ultérieurs.

outcome
enum<string>
required

Résultat de la synchronisation: created, updated, noop, restored ou bound. Conserver marko_id quel que soit ce résultat.

Available options:
created,
updated,
noop,
restored,
bound
resource
ExternalNoteResourceResponse · object
required

État de la ressource MARKO après la synchronisation externe.

request_id
string
required

Identifiant de corrélation pour le diagnostic de la requête.

taxonomy_additions
EntityTaxonomyOptionResponse · object[]

Options de taxonomie créées par cet upsert. Conservez les codes retournés; le suffixe custom__ n'est pas prévisible.