Actions122
- Availability Actions
- Branch Actions
- Call Log Actions
- Client Portal Actions
- Completion Actions
- Contact Actions
- Contact Note Actions
- Contact Order Actions
- Contact Referral Actions
- Document Actions
- Global Search Actions
- Lead Actions
- Listing Actions
- Listing Inspection Actions
- Listing Issue Actions
- Listing Key Actions
- Listing Link Actions
- Listing Media Actions
- Listing Note Actions
- Listing Offer Actions
- Listing Onboarding Check Actions
- Listing Room Actions
- Listing Search Actions
- Listing Valuation Actions
- Listing Viewing Actions
- Notification Actions
- Search Region Actions
- Task Actions
- Tenancy Actions
- User Actions
- Webhook Actions
Tenancy → Update
AI-generatedSummary
Update a tenancy record by its Tenancy ID, modifying deposit-related fields as specified.
Inputs
- Tenancy ID (required) — Numeric ID of the tenancy to update.
- Update Fields — Optional deposit-related fields to update on the tenancy, including deposit currency, amount, scheme, scheme reference, and the date the deposit was received (in 'YYYY-MM-DD HH:mm:ss' format).
- Custom Headers — Additional HTTP headers to include with the update request.
Output shape
a single updated tenancy object reflecting the applied changes
The output contains the updated tenancy data. Only fields supplied in "Update Fields" are modified. Errors occur if the tenancy ID is invalid or the update fails.
Examples
Example 1: Update a tenancy with ID 123, setting deposit amount to 1000 GBP under the 'Deposit Protection Service' scheme, with a deposit receipt date.
Tenancy ID: 123; Update Fields: Deposit Currency = GBP, Deposit Amount = 1000, Deposit Scheme = Deposit Protection Service; Date Deposit Received = current date-time in 'YYYY-MM-DD HH:mm:ss'.