Skip to main content
Each entry lists the changes introduced in that API version. See API versioning for how to upgrade and roll back. Versions are listed newest first.
​
  • Added identifier — The identifier field has been added to the loyalty program event object. When set, creating another event with the same identifier on the same programme returns the original event. (loyalty.program_event)
​
  • Added channels and email_delivery — The channels and email_delivery fields have been added to the loyalty message object. channels lists the requested delivery methods (push and/or email). email_delivery summarises email attempts when email is included, and is null otherwise. (loyalty.message)
  • Added automatic_grant — The automatic_grant field has been added to the loyalty program object. When set and enabled is true, Yorlet grants the programme automatically for supported types. null means grants stay manual, via a workflow, or via the API. (loyalty.program)
  • Added application_locked — The application_locked field has been added to the subscription object. It is true when the subscription was created from an application, in which case the association is permanent and cannot be changed or removed. (subscription)
​
  • Added redaction field — The redaction field has been added to the customer object. It is set when a redaction has been created for the customer, with a status of processing or redacted, and a redacted_at timestamp once complete. (customer)
​
  • Added last_customer_message_at and unread_messages fields — The last_customer_message_at and unread_messages fields have been added to the maintenance issue object. (maintenance.issue)
  • Added maintenance_issue field — The maintenance_issue field has been added to the document object. (document)
​
  • Added viewing_booking_url field — The viewing_booking_url field has been added to the building object. It is the public URL a lead can use to book a viewing at the building, once a booking link has been minted. (building)
  • Added viewings_availability field — The viewings_availability field has been added to the building object. It holds optional weekly viewing hours for the building. null inherits the account viewing calendar. (building)
  • Added viewings_require_confirmation field — The viewings_require_confirmation field has been added to the building object. It overrides whether public building booking links need a team member to confirm them. null inherits the account setting. (building)
  • Added building field — The building field has been added to the enquiry object. It is set when the enquiry is created from a building viewing booking link. (leads.enquiry)
  • Added mandate field — The mandate field has been added to the payment method object. It holds the Direct Debit mandate reference and hosted URL when the payment method is a Bacs or SEPA debit. (payment_method)
  • Added building field — The building field has been added to the viewing object. It is the building the viewing is booked against, used for per-building availability and collisions. (leads.viewing)
  • Added pending viewing status — The status field on the viewing object now includes pending, used when a public building booking link is waiting for a team member to confirm it. (leads.viewing)
​
  • Added automatic_deposit and requires_external_transfer — The automatic_deposit and requires_external_transfer fields have been added to the deposit object. automatic_deposit reports whether automatic scheme registration is enabled, the latest provider status, and the last registration error. requires_external_transfer is true when a GB custodial deposit still needs to be transferred to a scheme. (deposit)
  • Added actor field — The actor field has been added to the message object, identifying the user, agent, or API key that sent an outbound message. null for inbound messages and for messages recorded before actor attribution existed. (message)
  • Added unread field — The unread field has been added to the thread object. It is true when the authenticated user has inbound messages they have not seen. Always false for API key requests. (thread)
  • Added actor field — The actor field has been added to the timeline entry object, identifying the user, agent, or API key that performed the activity. null for entries recorded before actor attribution existed. (timeline_entry)
​
  • Added access_instructions field — The access_instructions field has been added to the maintenance issue object. (maintenance.issue)
​
  • Added request.actor field — The request.actor field has been added to the event object, identifying the user, agent, or API key that caused the event. (event)
​
  • Added late_fee billing reason — The billing_reason field on the invoice object now includes late_fee, used when an invoice is created to charge a late payment fee. (invoice)
  • Added variables field — The variables field has been added to the letter template object, and matching variables.\<key\> paths are included in merge_fields. (letter_template)
  • Added variables field — The variables field has been added to the letter object for custom template values. (letter)
​
  • Nested expense and fee (breaking) — The expense_code, fee_code, and fee_discount fields have been replaced by nested expense and fee objects. fee.discount is { end, percent_off } instead of a percentage number. expense and fee are omitted when they do not apply to the collection type. (account_collection)
  • Added archived and archived_at fields — The archived and archived_at fields have been added to the application configuration object. Archived configurations are excluded from list responses unless archived=true is passed. (application_configuration)
  • Added application field — The application field has been added to the enquiry object. It holds the ID of the application the enquiry was converted into, set when an application is created with enquiry. (leads.enquiry)
  • Added portal field — The portal field has been added to the enquiry object. It is present when source is portal and is polymorphic on type. The first supported type is rightmove, with portal-specific details under rightmove. (leads.enquiry)
  • Added SLA and on-hold fields — The first_responded_at, on_hold, and sla fields have been added to the maintenance issue object. on_hold is a nested object with at and reason, or null when the issue is not on hold. sla is a nested object with paused_seconds, resolution_due_at, response_due_at, and status. (maintenance.issue)
  • Nested availability fields (breaking) — The availability_days, availability_every_day, and availability_time_slots fields have been replaced by a nested availability object. availability is null when availability has not been set. (maintenance.issue)
  • Nested triage fields (breaking) — The triage_enabled, triage_portal_completion_session, and triage_resolved fields have been replaced by a nested triage object. triage is null when triage is not enabled. (maintenance.issue)
  • Added consumer_link and source fields — The consumer_link and source fields have been added to the resident object. consumer_link is one of none, pending, linked, or rejected and reports whether the OneMove user has confirmed they live at the building. source is manual or tenancy. (resident)
  • Added apply_url — The apply_url field has been added to the unit object. It contains the public URL an applicant can use to apply for the unit, and is only present while the unit is released to the market and self-serve applications are enabled on the account. (unit)
  • Added availability and active_tenancy_end — The availability object has been added to the unit object, describing the letting state of the unit (to_let, coming_available, held, under_offer, and so on) alongside the release decision behind it. The end date of the occupying tenancy is also now exposed as active_tenancy_end. (unit)
​
  • Added videos field — The videos field has been added to the maintenance issue object. (maintenance.issue)
​
  • Added liability field — The liability field has been added to the dispute object. (dispute)
​
No changes to existing objects.
​
No changes to existing objects.
​
Initial version.