Updated October 29, 2026
Tenants API
Explore 25 documented operations, including request parameters, body schemas, and responses.
Operations
Choose an operation to view its contract and a request example. Authentication and environment availability depend on the route.
GET
List Tenants
/v1/facilities/{facility_id}/tenantsPOST
Create Tenant
/v1/facilities/{facility_id}/tenantsGET
Get Tenant
/v1/tenants/{tenant_id}PATCH
Update Tenant
/v1/tenants/{tenant_id}PATCH
Update Tenant Address
/v1/tenants/{tenant_id}/addressPOST
Set Tenant Address
/v1/tenants/{tenant_id}/addressGET
Get Communication Preferences
/v1/tenants/{tenant_id}/communication-preferencesPATCH
Update Communication Preferences
/v1/tenants/{tenant_id}/communication-preferencesGET
List Tenant Communications
/v1/tenants/{tenant_id}/communicationsGET
List Tenant Contacts
/v1/tenants/{tenant_id}/contactsPOST
Add Tenant Contact
/v1/tenants/{tenant_id}/contactsDELETE
Delete Tenant Contact
/v1/tenants/{tenant_id}/contacts/{contact_id}PATCH
Update Tenant Contact
/v1/tenants/{tenant_id}/contacts/{contact_id}DELETE
Clear Do Not Rent
/v1/tenants/{tenant_id}/do-not-rentPOST
Set Do Not Rent
/v1/tenants/{tenant_id}/do-not-rentGET
List Tenant Documents
/v1/tenants/{tenant_id}/documentsDELETE
Revoke Marketing Sms Consent
/v1/tenants/{tenant_id}/marketing-sms-consentPOST
Record Marketing Sms Consent
/v1/tenants/{tenant_id}/marketing-sms-consentGET
List Tenant Payment Methods
/v1/tenants/{tenant_id}/payment-methodsPOST
Create Payment Method
/v1/tenants/{tenant_id}/payment-methodsPOST
Open Payment Method Session
/v1/tenants/{tenant_id}/payment-methods/sessionPOST
Create Payment Method At Terminal
/v1/tenants/{tenant_id}/payment-methods/terminalGET
List Payments For Tenant
/v1/tenants/{tenant_id}/paymentsDELETE
Revoke Sms Consent
/v1/tenants/{tenant_id}/sms-consentPOST
Record Sms Consent
/v1/tenants/{tenant_id}/sms-consentTry a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Response
Your response will appear here.