Passer au contenu principal
PATCH
Mettre à jour les critères d'une acquisition

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

acquisitionId
string
requis

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

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

"618a35a36d932054e195ca0a"

Corps

application/json

Au moins un champ. Critères de recherche uniquement — step, customId, parsingCustomId, mandate, owner, agency et areas ne sont pas modifiables.

project
string
activityLevel
string
propertiesTypes
string[]
priceRange
object

Fourchette de valeurs.

sizeRange
object

Fourchette de valeurs.

fieldRange
object

Fourchette de valeurs.

roomRange
object

Fourchette de valeurs.

bedroomRange
object

Fourchette de valeurs.

floorRange
object

Fourchette de valeurs.

elevator
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
outdoor
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
parking
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
pool
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
lastFloor
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
groundFloor
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
singleStorey
enum<string>

excluded : critère éliminatoire, le bien ne doit pas en avoir.

Options disponibles:
unnecessary,
preferable,
essential,
excluded
bikeShed
boolean

Local vélo souhaité.

mortgage
boolean

L'acquéreur finance par un crédit.

purpose
string

Réponse

Acquisition mise à jour.

success
boolean
acquisition
object

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