Clients

Créer ou mettre à jour un client (upsert par SIRET)

Crée un client ; si son SIRET/TVA/e-mail est déjà connu, met à jour la fiche au lieu d'en créer un doublon. Seuls les champs envoyés changent : un champ absent garde la valeur de la fiche, un champ envoyé vide l'efface. Scope requis : clients:write.

post/clients

Request

  • Base URL: https://api.swipify.fr/api/v1
  • URL: https://api.swipify.fr/api/v1/clients
  • Auth: API key in header X-API-Key

Headers

Idempotency-Keystring

Clé d'idempotence (un UUID est recommandé). Optionnelle mais conseillée sur les retries réseau : la première réponse 2xx est mémorisée par (organisation, clé) ~24 h et rejouée au lieu de recréer la ressource (évite les doublons de facture/devis/client). Réutiliser la même clé pour une autre requête (méthode/chemin différents) renvoie 422. L'en-tête X-Idempotency-Key est accepté comme alias équivalent.

Request body

type'company' | 'individual' required
namestring nullable
firstNamestring required
lastNamestring required
emailstring email nullable

Sans accent avant l'arobase ; un domaine accentué est accepté.

phonestring nullable

Numéro français (06…, +33…, outre-mer compris) ou étranger avec son indicatif, 8 à 15 chiffres en tout, comme +32 470 12 34 56.

addressstring nullable
zipCodestring nullable
citystring nullable
countrystring nullable
siretstring nullable
vatNumberstring nullable

Numéro de TVA intracommunautaire, français (FR, clé de deux caractères, SIREN) ou d'un autre pays (les deux lettres du pays puis 2 à 13 caractères, dont au moins un chiffre), comme FR32123456789 ou BE0123456789. Espaces, points et tirets sont acceptés, le numéro est enregistré sans eux.

formeJuridiquestring nullable

Response

Client créé ou mis à jour

idinteger
type'company' | 'individual'
namestring
emailstring nullable
phonestring nullable
addressstring nullable
siretstring nullable
vatNumberstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.