Lessees

Update lessee

Updates the information of an existing lessee

put/lessees/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/lessees/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Unique lessee ID

Request body

category'individual' | 'company/other' | 'guarantor'

Lessee category

titlestring

Title (Mr., Mrs., etc.)

first_namestring

First name

last_namestring

Last name

legal_namestring

Legal name (for companies)

birth_datestring date

Date of birth

birth_placestring

Place of birth

emailstring email

Email address

mobile_phonestring

Mobile phone number

landline_phonestring

Landline phone number

address_countrystring

Country

address_complementstring

Address complement

address_street_numberstring

Street number

address_street_namestring

Street name

address_localitystring

Locality, district, or borough

address_postal_codestring

Postal code

address_citystring

City

address_postal_boxstring

PO Box

professionstring

Profession

employer_namestring

Employer name

employer_phonestring

Employer phone

monthly_incomenumber

Monthly income

other_incomenumber

Other income

bank_namestring

Bank name

ibanstring

IBAN code

bicstring

BIC/SWIFT code

additional_addressesobject

Additional addresses (JSON)

identity_documentsobject

Identity documents (JSON)

additional_contactsobject

Additional contacts (JSON)

custom_fieldsobject

Custom fields (JSON)

auth_user_idstring

Better Auth user ID

Example request

{
  "category": "individual"
}

Response

Lessee updated successfully

idstring uuid required

Unique identifier of the lessee

category'individual' | 'company/other' | 'guarantor' required

Lessee category

titlestring

Title (Mr., Mrs., etc.)

first_namestring

First name

last_namestring

Last name

legal_namestring

Legal name (for companies)

birth_datestring date nullable

Date of birth

birth_placestring

Place of birth

emailstring email

Email address

mobile_phonestring

Mobile phone number

landline_phonestring

Landline phone number

address_countrystring

Country

address_complementstring

Address complement

address_street_numberstring

Street number

address_street_namestring

Street name

address_localitystring

Locality, district, or borough

address_postal_codestring

Postal code

address_citystring

City

address_postal_boxstring

PO Box

professionstring

Profession

employer_namestring

Employer name

employer_phonestring

Employer phone

monthly_incomenumber nullable

Monthly income

other_incomenumber nullable

Other income

bank_namestring

Bank name

ibanstring

IBAN code

bicstring

BIC/SWIFT code

additional_addressesobject nullable

Additional addresses (JSON)

identity_documentsobject nullable

Identity documents (JSON)

additional_contactsobject nullable

Additional contacts (JSON)

custom_fieldsobject nullable

Custom fields (JSON)

auth_user_idstring nullable

Better Auth user ID

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "category": "individual",
  "title": "M.",
  "first_name": "Jean",
  "last_name": "Dupont",
  "legal_name": "SARL Dupont & Associés",
  "birth_date": "1985-03-15",
  "birth_place": "Paris",
  "email": "jean.dupont@example.com",
  "mobile_phone": "+33 6 12 34 56 78",
  "landline_phone": "+33 1 23 45 67 89",
  "address_country": "France",
  "address_complement": "Appartement 12",
  "address_street_number": "123",
  "address_street_name": "rue de la Paix",
  "address_locality": "1er arrondissement",
  "address_postal_code": "75001",
  "address_city": "Paris",
  "address_postal_box": "123",
  "profession": "Ingénieur",
  "employer_name": "TechCorp SAS",
  "employer_phone": "+33 1 98 76 54 32",
  "monthly_income": 3500,
  "other_income": 500,
  "bank_name": "Crédit Agricole",
  "iban": "FR76 1234 5678 9012 3456 7890 123",
  "bic": "AGRIFRPP",
  "additional_addresses": {
    "work": "456 avenue des Champs-Élysées, 75008 Paris"
  },
  "identity_documents": {
    "passport": "12AB34567",
    "id_card": "123456789"
  },
  "additional_contacts": {
    "emergency": "+33 6 98 76 54 32",
    "family": "+33 1 11 22 33 44"
  },
  "custom_fields": {
    "preferred_language": "fr",
    "special_needs": "wheelchair access"
  },
  "auth_user_id": "user_123456789",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

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