Passer au contenu principal
POST
Changer le titulaire d’une location

Autorisations

Authorization
string
header
requis

Clé API lck_… créée dans Lexio (Paramètres → Développeur), envoyée en Authorization: Bearer. Voir Authentification.

En-têtes

Idempotency-Key
string
requis

Clé unique de l’opération, réutilisée à chaque nouvel essai : un rejeu avec la même clé et le même corps renvoie la réponse initiale sans rien réécrire. Voir Idempotence. Facultative avec ?dryRun=true sur les opérations qui l’acceptent.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$
Exemple:

"8b3e1d2c-4a5f-4c6b-9e7d-1f2a3b4c5d6e"

Paramètres de chemin

rentalId
string<uuid>
requis

Identifiant de la location.

Exemple:

"9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f"

Paramètres de requête

dryRun
enum<string>

true : aperçu, la même action annulée en fin de transaction.

Options disponibles:
true,
false

Corps

application/json
customerId
string<uuid>

Clé interne seulement (clé partenaire → 400 not_applicable). Inconnu → 422 REFERENCE_NOT_FOUND ; anonymisé → 422 REFERENCE_INACTIVE ; égal au titulaire actuel → 400 invalid_value.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

customer
object

Même objet qu’à la création : repris par email parmi les fiches particulier de l’espace de la clé (fiches internes pour une clé interne), sinon créé. Une fiche reprise est gardée telle quelle : seuls ses champs vides sont complétés. Repris sur le titulaire actuel → 400 invalid_value.

expectedTotalTTC
number

Total TTC affiché par l’aperçu (dryRun). Écart d’au moins une unité mineure avec le total recalculé → 409 PRICE_CHANGED.

overpaymentResolution
enum<string>

REFUND_PENDING : remboursement PENDING par virement du trop-perçu ; NO_REFUND : le loueur le conserve. Exige le scope payments.refund.

Options disponibles:
REFUND_PENDING,
NO_REFUND

Réponse

Changer le titulaire d’une location

data
object
requis

Location, dans la même représentation pour la lecture, la liste et chaque écriture. Montants dans currency, voir Montants et TVA.

Exemple:
effects
object
requis