Update a renewal intent
curl --request POST \
--url https://api.yorlet.com/v1/renewal_intents/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"assignee": "<string>",
"metadata": {},
"no_renewal": {
"end_date": 123,
"sub_reason": "<string>",
"reason_description": "<string>"
},
"renewal": {
"end_date": 123,
"start_date": 123
},
"rent_increase": {
"current_rent": 123,
"proposed_rent": 123,
"notice_served_at": 123,
"effective_date": 123,
"tribunal_reference": "<string>",
"tribunal_outcome_rent": 123,
"tribunal_decided_at": 123,
"reversed_at": 123
},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"last_increase_at": 123,
"first_increase_at": 123
}
},
"send_form_4": true
}
'{
"id": "<string>",
"created": 123,
"object": "renewal_intent",
"application": {
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
},
"canceled_at": 123,
"completed_at": 123,
"source_application": {
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
},
"unit": "<string>",
"account": "<string>",
"deleted": false,
"assignee": "<string>",
"due_at": 123,
"no_renewal": {
"end_date": 123,
"reason": "<string>",
"reason_description": "<string>",
"sub_reason": "<string>"
},
"renewal": {
"end_date": 123,
"start_date": 123
},
"rent_increase": {
"current_rent": 123,
"proposed_rent": 123,
"notice_served_at": 123,
"notice_file": "<string>",
"notice_file_url": "<string>",
"effective_date": 123,
"tribunal_reference": "<string>",
"tribunal_outcome_rent": 123,
"tribunal_decided_at": 123,
"reversed_at": 123
},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"last_increase_at": 123,
"first_increase_at": 123
}
}
}Renewal Intents
Update a renewal intent
Updates the specified renewal intent. For rent_increase type, you can transition the status through the rent increase flow (pending -> notice_served -> accepted/challenged -> effective) and set rent increase fields. The notice_served_at date cannot be in the past. By default, notice can only be served on or after the system-suggested due date, and the effective_date must be at least 12 months after the last rent increase or tenancy start. Accounts can enable the renewals “allow_early_notice” setting to waive those timing restrictions and serve notice at any time without enforcing the 12-month cycle. The effective_date must always be at least 2 months after notice_served_at. Pass send_form_4=true alongside a status=notice_served transition to email the tenants the rent increase notice with the Form 4 attached.
POST
/
v1
/
renewal_intents
/
{id}
Update a renewal intent
curl --request POST \
--url https://api.yorlet.com/v1/renewal_intents/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"assignee": "<string>",
"metadata": {},
"no_renewal": {
"end_date": 123,
"sub_reason": "<string>",
"reason_description": "<string>"
},
"renewal": {
"end_date": 123,
"start_date": 123
},
"rent_increase": {
"current_rent": 123,
"proposed_rent": 123,
"notice_served_at": 123,
"effective_date": 123,
"tribunal_reference": "<string>",
"tribunal_outcome_rent": 123,
"tribunal_decided_at": 123,
"reversed_at": 123
},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"last_increase_at": 123,
"first_increase_at": 123
}
},
"send_form_4": true
}
'{
"id": "<string>",
"created": 123,
"object": "renewal_intent",
"application": {
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
},
"canceled_at": 123,
"completed_at": 123,
"source_application": {
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
},
"unit": "<string>",
"account": "<string>",
"deleted": false,
"assignee": "<string>",
"due_at": 123,
"no_renewal": {
"end_date": 123,
"reason": "<string>",
"reason_description": "<string>",
"sub_reason": "<string>"
},
"renewal": {
"end_date": 123,
"start_date": 123
},
"rent_increase": {
"current_rent": 123,
"proposed_rent": 123,
"notice_served_at": 123,
"notice_file": "<string>",
"notice_file_url": "<string>",
"effective_date": 123,
"tribunal_reference": "<string>",
"tribunal_outcome_rent": 123,
"tribunal_decided_at": 123,
"reversed_at": 123
},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"last_increase_at": 123,
"first_increase_at": 123
}
}
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Body
application/json
The ID of the user the renewal intent is assigned to.
Pattern:
^[a-zA-Z0-9_]+$Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Details when the renewal intent type is no_renewal.
Show child attributes
Show child attributes
Details when the renewal intent type is renewal.
Show child attributes
Show child attributes
Details when the renewal intent type is rent_increase.
Show child attributes
Show child attributes
Manual overrides for system-derived values used when generating documents such as the Form 4A rent increase notice.
Show child attributes
Show child attributes
When transitioning a rent increase intent to notice_served, send the rent increase notice email with Form 4 attached to the tenants. If false or omitted, the email is not sent and can be sent later from the rent review page.
The status of the renewal intent.
Available options:
notice_served, accepted, challenged, tribunal_decided, effective, withdrawn The type of renewal intent.
Available options:
no_renewal, renewal, rent_increase Response
200 - application/json
Returns the renewal intent if the update succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
renewal_intent The new application created when this renewal is accepted.
Show child attributes
Show child attributes
The time at which the renewal intent was canceled.
The time at which the renewal intent was completed.
The application the renewal intent is being created from.
Show child attributes
Show child attributes
The status of the renewal intent.
Available options:
accepted, canceled, challenged, complete, effective, leaving, notice_served, pending, renewing, tribunal_decided, withdrawn The type of renewal intent.
Available options:
no_renewal, renewal, rent_increase, null The unit the renewal intent is associated with.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The ID of the user the renewal intent is assigned to.
The time at which the renewal intent is due to be actioned.
Details when the renewal intent type is no_renewal.
Show child attributes
Show child attributes
Details when the renewal intent type is renewal.
Show child attributes
Show child attributes
Details when the renewal intent type is rent_increase.
Show child attributes
Show child attributes
Manual overrides for values that are otherwise derived from the system, used when generating documents such as the Form 4A rent increase notice.
Show child attributes
Show child attributes
Was this page helpful?
⌘I