Passer au contenu principal
POST
Créer ou mettre à jour une vente

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.

Corps

application/json
settings
object
requis
transactionType
string
requis
Allowed value: "sale"
address
string
requis

Adresse complète du bien (ex: "11 rue de Paris, 75001 Paris, France"), située par Google. Si Google ne situe que la ville, la vente est enregistrée sans numéro ni rue et la réponse reste un succès : contrôlez transaction.property.addressData dans la réponse, ou property.addressData avec GET Sale.

transaction
object
requis
appointment
object

Crée un RDV (titre auto « Rendez-vous estimation »), sans renseigner les dates d'estimation de la fiche. Avec settings.step: RDV, la vente est créée à l'étape RDV avec ce rendez-vous à venir.

note
object
contact
object

Réponse

Vente créée ou mise à jour. Peut aussi retourner { success: true, message: "BILLING_STANDBY" } lorsque le compte est en standby de facturation.

success
boolean
avestId
string

Identifiant métier de la transaction créée / mise à jour.

user
object

Utilisateur alloué à la transaction.

contact
object
transaction
object
message
string

Présent lorsque le compte est en standby de facturation (BILLING_STANDBY).