Rent Receipts
Lessees

Set my email consent for a lease (tenant)

The connected tenant grants or revokes, for themselves, the right to receive their receipts by email on this lease (ALUR §6: always revocable).

Only the caller's own consent is touched, and only on a lease they are attached to; anything else answers 404.

The landlord-side equivalents are PUT /leases/{lease_id}/lessees/{lessee_id}/consent (set it directly) and POST /leases/{lease_id}/lessees/{lessee_id}/request-consent (ask the tenant to do it here).

Requires the lessee:profile:write permission.

put/tenant/leases/{lease_id}/consent

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/tenant/leases/{lease_id}/consent
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Request body

electronic_delivery_consentboolean required

Response

Consent recorded: the updated association is returned.

idstring uuid required

Unique identifier of the association

lease_idstring uuid required

Associated lease ID

lessee_idstring uuid required

Associated lessee ID

role_type'PRIMARY' | 'CO_TENANT' | 'GUARANTOR' required

Role of the lessee in the lease

rent_sharenumber nullable

Rent share for this lessee (if co-tenancy)

start_datestring date required

Start date of the association

end_datestring date nullable

End date of the association

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

created_by_amendment_idstring uuid nullable

Amendment ID that created this association

ended_by_amendment_idstring uuid nullable

Amendment ID that ended this association

guarantor_max_amountnumber nullable

Maximum guaranteed amount (if role = GUARANTOR)

guarantor_conditionsstring nullable

Specific guarantee conditions

guarantees_lessee_idstring uuid nullable

Lessee ID guaranteed by this guarantor (if role = GUARANTOR)

guarantor_engagement_type'SIMPLE' | 'SOLIDAIRE' nullable

Nature of the surety's undertaking (if role = GUARANTOR).

A guarantor with no guarantor_max_amount and no guarantor_engagement_type cannot be committed: the surety deed cannot be drawn up, and the signature pre-flight will report a caution_incomplete blocker.

Any value other than SIMPLE or SOLIDAIRE is rejected: it is never silently treated as "unset".

electronic_delivery_consentboolean required

Whether this tenant has consented to receiving documents: rent receipts in particular: by email (ALUR §6).

Consent is per tenant and per lease, and is revocable. Rent receipts are not emailed to a tenant whose consent is false.

Set it as the landlord with PUT /leases/{lease_id}/lessees/{lessee_id}/consent, ask the tenant for it with POST /leases/{lease_id}/lessees/{lessee_id}/request-consent, or let the tenant set it themselves from their portal with PUT /tenant/leases/{lease_id}/consent.

consent_updated_atstring date-time nullable

When electronic_delivery_consent was last changed. null if never set.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "lease_id": "550e8400-e29b-41d4-a716-446655440000",
  "lessee_id": "550e8400-e29b-41d4-a716-446655440001",
  "role_type": "PRIMARY",
  "rent_share": 0.5,
  "start_date": "2024-01-01",
  "end_date": "2025-01-01",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by_amendment_id": "550e8400-e29b-41d4-a716-446655440002",
  "ended_by_amendment_id": "550e8400-e29b-41d4-a716-446655440004",
  "guarantor_max_amount": 10000,
  "guarantees_lessee_id": "550e8400-e29b-41d4-a716-446655440003",
  "guarantor_engagement_type": "SOLIDAIRE",
  "electronic_delivery_consent": true,
  "consent_updated_at": "2026-03-14T09:12:00Z"
}

Changes

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