Passer au contenu principal
PATCH

Autorisations

Authorization
string
header
requis

Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.

La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.

Paramètres de chemin

saleId
string
requis

id (ObjectId) ou customId de la vente.

Corps

application/json

Au moins un champ. contacts, customId, parsingCustomId, commission et state ne sont pas modifiables par cette route.

step
enum<string>

Nouvelle étape de la vente. Le changement produit les mêmes effets que depuis l'interface (activité de changement d'étape, stepUpdatedAt, commission, séquences paramétrées par l'agence). Vers une étape de QUL à DLV, les activités à faire de la fiche sont closes (rendez-vous compris, visites et offres exceptées). Une vente sans responsable ne sort de STK, TRN, PQUL, ARC, SLD ou TARC qu'avec owner dans la même requête : sinon l'étape reste inchangée, avec un 200. Passer en STK retire le responsable et supprime les activités non clôturées (visites et offres conservées).

Options disponibles:
STK,
TRN,
ARC,
PQUL,
QUL,
CNV,
RDV,
DLV,
MND,
TARC,
OFR,
AGT,
MTG,
SLD
stepUpdateReason
enum<string>

Motif accompagnant le changement d'étape. Vers ARC : fakePhone, unreachable, spam, noFollowUp ou lostMandate. Vers TARC : marketedElsewhere, soldByOtherAgency, soldByOwner, saleWithdrawn, lostMandate ou noFollowUp. Sinon 400 (Invalid stepUpdateReason for step ARC). fakePhone marque aussi les téléphones du contact comme invalides.

Options disponibles:
fakePhone,
unreachable,
spam,
noFollowUp,
lostMandate,
marketedElsewhere,
soldByOtherAgency,
soldByOwner,
saleWithdrawn
project
string

Projet du vendeur (S|S, S|L, S|O, APT, ...).

status
string

Statut, dépendant de l'étape courante.

fieldValue
object

Fourchette de valeurs.

onlineValue
object

Fourchette de valeurs.

timeline
object

Dates officielles du dossier. Ce sont les dates affichées sur la fiche : estimationDate est la date du rendez-vous d'estimation, pas la date d'une activité. Envoyer null sur une date l'efface.

appointment
object

Raccourci : renseigne le créneau d'estimation (timeline.estimationDate / estimationStartAt / estimationEndAt) et crée l'activité « Rendez-vous estimation ». Sur POST /external-integration/sale, le même champ crée l'activité sans renseigner les dates de la fiche. Envoyé avec step, le rendez-vous est créé après le changement d'étape et reste ouvert. L'activité créée est renvoyée dans la réponse.

property
object

Caractéristiques du bien. L'adresse ne s'écrit pas ici : utilisez le champ address.

address
string

Adresse en texte libre, géocodée comme à la création. Remplace l'adresse enregistrée sur le bien. Si Google ne situe que la ville, la vente est enregistrée sans numéro ni rue : contrôlez property.addressData dans la réponse.

owner
string

Collaborateur responsable de la fiche. Doit appartenir aux agences de votre clé API, sinon la requête est refusée et rien n'est écrit.

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

tags
string[]

Liste complète des tags de la vente : les tags absents de la liste sont retirés. Chaque tag doit exister dans votre périmètre.

Identifiant Mongo (24 caractères hexadécimaux).

Pattern: ^[a-fA-F0-9]{24}$
mandate
object

Montants en euros. sellPrice est le net vendeur. Le prix affiché honoraires inclus (price) est calculé : net vendeur + honoraires. Pour saisir les honoraires en pourcentage, envoyez commissionType: percentage et commissionPercentage : le montant des honoraires est alors calculé.

offer
object

Mêmes règles que le mandat : montants en euros, sellPrice net vendeur, honoraires en pourcentage avec commissionType: percentage (montants arrondis à l'euro, pourcentage inférieur à 100). L'offre n'est enregistrée que sur une vente à MND ou au-delà ; un changement d'étape vers une autre étape que OFR, AGT, MTG ou SLD l'efface.

Réponse

Vente mise à jour.

success
boolean
sale
object

Vente en lecture. id, customId, agency, agencyGroup, step, createdAt, updatedAt, stepUpdatedAt, owner et mainContact sont toujours présents (si la vente existe). Les autres champs sont absents s'ils ne sont pas renseignés.

activity
object

Activité « Rendez-vous estimation » créée. Présente uniquement si appointment était fourni.