Leases
Lessees

Invite a tenant to their FairePlace portal

Sends the tenant an invitation to their own space, where they can see their leases, download their rent receipts and manage their email consent.

The invitation is queued, not sent inline: hence 202. It reuses the same machinery as the send-to-sign invitation: a lessee organisation invite, a magic link, and a welcome email.

Requirements:

  • the tenant must be attached to this lease, otherwise 404 (not 403: the API does not reveal that a tenant exists elsewhere);
  • the tenant must have an email address, otherwise the call is rejected.

Note {lessee_id} is the person's id.

post/leases/{lease_id}/lessees/{lessee_id}/invite

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/lessees/{lessee_id}/invite
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
lessee_idstring uuid required

The tenant (person) id, not the lease-lessee association id.

Response

Invitation accepted for delivery.

invitedboolean

Example response

{
  "invited": true
}

Changes

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