Skip to main content

API releases — 2024

All API releases · How to read this history

15 November 2024 — Existing contact matching for leads​

  • Lead input gains contactMatchExisting to select how an existing contact is matched.
  • The available matching combinations are email; email and mobile; email and name; email, mobile and name; email and date of birth; or email, date of birth and name.

306 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 1 added, 0 removed, 1 updated

Added schemas

  • ExistingContactCheck

Updated schemas and changed locations

  • LeadAttributes: /properties/contactMatchExisting

11 November 2024 — Lead naming and referral context​

  • Lead and structured lead inputs gain dealName and sourceReferrerId.
  • Referrer identifiers no longer carry the numeric-only constraint. Organisations gain the read-only isBrokerSearchVisible field.
  • Supporting geometry enum values change, including Point, Surface, False, Z and M.

Compatibility: Treat referrer identifiers as opaque strings. Review generated enum mappings if your client exposes geometry schemas.

306 operations after this release · 0 added · 0 removed · 150 updated. Schema changes are counted separately below.

Endpoint details

Updated definitions

  • GET /jsonapi/referrers/{id}
  • HEAD /jsonapi/adviser-details
  • HEAD /jsonapi/adviser-details/{id}
  • HEAD /jsonapi/adviser-details/{id}/adviser
  • HEAD /jsonapi/adviser-details/{id}/relationships/adviser
  • HEAD /jsonapi/advisers
  • HEAD /jsonapi/advisers/{id}
  • HEAD /jsonapi/advisers/{id}/addresses
  • HEAD /jsonapi/advisers/{id}/adviserDetails
  • HEAD /jsonapi/advisers/{id}/agreementHolders
  • HEAD /jsonapi/advisers/{id}/contactGroups
  • HEAD /jsonapi/advisers/{id}/organisation
  • HEAD /jsonapi/advisers/{id}/relationships/addresses
  • HEAD /jsonapi/advisers/{id}/relationships/adviserDetails
  • HEAD /jsonapi/advisers/{id}/relationships/agreementHolders
  • HEAD /jsonapi/advisers/{id}/relationships/contactGroups
  • HEAD /jsonapi/advisers/{id}/relationships/organisation
  • HEAD /jsonapi/asset-categories
  • HEAD /jsonapi/asset-categories/{id}
  • HEAD /jsonapi/asset-sub-types
  • HEAD /jsonapi/asset-sub-types/{id}
  • HEAD /jsonapi/asset-types
  • HEAD /jsonapi/asset-types/{id}
  • HEAD /jsonapi/assets
  • HEAD /jsonapi/assets/{id}
  • HEAD /jsonapi/assets/{id}/addresses
  • HEAD /jsonapi/assets/{id}/ownership
  • HEAD /jsonapi/assets/{id}/relationships/addresses
  • HEAD /jsonapi/assets/{id}/relationships/ownership
  • HEAD /jsonapi/contact-external-references
  • HEAD /jsonapi/contact-external-references/{id}
  • HEAD /jsonapi/contact-external-references/{id}/contact
  • HEAD /jsonapi/contact-external-references/{id}/integration
  • HEAD /jsonapi/contact-external-references/{id}/relationships/contact
  • HEAD /jsonapi/contact-external-references/{id}/relationships/integration
  • HEAD /jsonapi/contact-groups
  • HEAD /jsonapi/contact-groups/{id}
  • HEAD /jsonapi/contact-groups/{id}/adviser
  • HEAD /jsonapi/contact-groups/{id}/businesses
  • HEAD /jsonapi/contact-groups/{id}/contacts
  • HEAD /jsonapi/contact-groups/{id}/referrer
  • HEAD /jsonapi/contact-groups/{id}/referrerOrganisation
  • HEAD /jsonapi/contact-groups/{id}/relationships/adviser
  • HEAD /jsonapi/contact-groups/{id}/relationships/businesses
  • HEAD /jsonapi/contact-groups/{id}/relationships/contacts
  • HEAD /jsonapi/contact-groups/{id}/relationships/referrer
  • HEAD /jsonapi/contact-groups/{id}/relationships/referrerOrganisation
  • HEAD /jsonapi/contacts
  • HEAD /jsonapi/contacts/{id}
  • HEAD /jsonapi/contacts/{id}/contactAddress
  • HEAD /jsonapi/contacts/{id}/contactGroup
  • HEAD /jsonapi/contacts/{id}/deals
  • HEAD /jsonapi/contacts/{id}/externalReferences
  • HEAD /jsonapi/contacts/{id}/ownership
  • HEAD /jsonapi/contacts/{id}/relationships/contactAddress
  • HEAD /jsonapi/contacts/{id}/relationships/contactGroup
  • HEAD /jsonapi/contacts/{id}/relationships/deals
  • HEAD /jsonapi/contacts/{id}/relationships/externalReferences
  • HEAD /jsonapi/contacts/{id}/relationships/ownership
  • HEAD /jsonapi/deal-external-references
  • HEAD /jsonapi/deal-external-references/{id}
  • HEAD /jsonapi/deal-external-references/{id}/deal
  • HEAD /jsonapi/deal-external-references/{id}/integration
  • HEAD /jsonapi/deal-external-references/{id}/relationships/deal
  • HEAD /jsonapi/deal-external-references/{id}/relationships/integration
  • HEAD /jsonapi/deal-notes/{id}
  • HEAD /jsonapi/deal-notes/{id}/deal
  • HEAD /jsonapi/deal-notes/{id}/relationships/deal
  • HEAD /jsonapi/deal-participants
  • HEAD /jsonapi/deal-participants/{id}
  • HEAD /jsonapi/deal-participants/{id}/contact
  • HEAD /jsonapi/deal-participants/{id}/deal
  • HEAD /jsonapi/deal-participants/{id}/relationships/contact
  • HEAD /jsonapi/deal-participants/{id}/relationships/deal
  • HEAD /jsonapi/deals
  • HEAD /jsonapi/deals/{id}
  • HEAD /jsonapi/deals/{id}/adviser
  • HEAD /jsonapi/deals/{id}/contacts
  • HEAD /jsonapi/deals/{id}/dealNotes
  • HEAD /jsonapi/deals/{id}/dealScenario
  • HEAD /jsonapi/deals/{id}/dealStructures
  • HEAD /jsonapi/deals/{id}/externalReferences
  • HEAD /jsonapi/deals/{id}/importantDates
  • HEAD /jsonapi/deals/{id}/participants
  • HEAD /jsonapi/deals/{id}/relationships/adviser
  • HEAD /jsonapi/deals/{id}/relationships/contacts
  • HEAD /jsonapi/deals/{id}/relationships/dealNotes
  • HEAD /jsonapi/deals/{id}/relationships/dealScenario
  • HEAD /jsonapi/deals/{id}/relationships/dealStructures
  • HEAD /jsonapi/deals/{id}/relationships/externalReferences
  • HEAD /jsonapi/deals/{id}/relationships/importantDates
  • HEAD /jsonapi/deals/{id}/relationships/participants
  • HEAD /jsonapi/enquiry-sources
  • HEAD /jsonapi/enquiry-sources/{id}
  • HEAD /jsonapi/expense-categories
  • HEAD /jsonapi/expense-categories/{id}
  • HEAD /jsonapi/expense-categories/{id}/expenseTypes
  • HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes
  • HEAD /jsonapi/expense-types
  • HEAD /jsonapi/expense-types/{id}
  • HEAD /jsonapi/expense-types/{id}/expenseCategory
  • HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory
  • HEAD /jsonapi/expenses
  • HEAD /jsonapi/expenses/{id}
  • HEAD /jsonapi/expenses/{id}/ownership
  • HEAD /jsonapi/expenses/{id}/relationships/ownership
  • HEAD /jsonapi/income-categories
  • HEAD /jsonapi/income-categories/{id}
  • HEAD /jsonapi/income-categories/{id}/incomeTypes
  • HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes
  • HEAD /jsonapi/income-types
  • HEAD /jsonapi/income-types/{id}
  • HEAD /jsonapi/income-types/{id}/incomeCategory
  • HEAD /jsonapi/income-types/{id}/relationships/incomeCategory
  • HEAD /jsonapi/incomes
  • HEAD /jsonapi/incomes/{id}
  • HEAD /jsonapi/incomes/{id}/linkedAsset
  • HEAD /jsonapi/incomes/{id}/ownership
  • HEAD /jsonapi/incomes/{id}/relationships/linkedAsset
  • HEAD /jsonapi/incomes/{id}/relationships/ownership
  • HEAD /jsonapi/integrations
  • HEAD /jsonapi/integrations/{id}
  • HEAD /jsonapi/integrations/{id}/contactExternalReferences
  • HEAD /jsonapi/integrations/{id}/dealExternalReferences
  • HEAD /jsonapi/integrations/{id}/relationships/contactExternalReferences
  • HEAD /jsonapi/integrations/{id}/relationships/dealExternalReferences
  • HEAD /jsonapi/liabilities
  • HEAD /jsonapi/liabilities/{id}
  • HEAD /jsonapi/liabilities/{id}/linkedAsset
  • HEAD /jsonapi/liabilities/{id}/ownership
  • HEAD /jsonapi/liabilities/{id}/relationships/linkedAsset
  • HEAD /jsonapi/liabilities/{id}/relationships/ownership
  • HEAD /jsonapi/liability-categories
  • HEAD /jsonapi/liability-categories/{id}
  • HEAD /jsonapi/liability-categories/{id}/liabilityTypes
  • HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes
  • HEAD /jsonapi/liability-types
  • HEAD /jsonapi/liability-types/{id}
  • HEAD /jsonapi/liability-types/{id}/liabilityCategory
  • HEAD /jsonapi/liability-types/{id}/relationships/liabilityCategory
  • HEAD /jsonapi/organisations
  • HEAD /jsonapi/organisations/{id}
  • HEAD /jsonapi/organisations/{id}/addresses
  • HEAD /jsonapi/organisations/{id}/relationships/addresses
  • HEAD /jsonapi/property-types
  • HEAD /jsonapi/property-types/{id}
  • HEAD /jsonapi/referrers
  • HEAD /jsonapi/referrers/{id}
  • PATCH /jsonapi/deal-notes/{id}/relationships/deal
  • POST /jsonapi/deal-notes/{id}/relationships/deal
Schema details — 0 added, 0 removed, 6 updated

Updated schemas and changed locations

  • Dimension: /enum
  • LeadAttributes: /properties/dealName, /properties/sourceReferrerId
  • Ordinates: /enum
  • OrganisationAttributes: /properties/isBrokerSearchVisible
  • Referrer: /properties/id/pattern
  • StructuredLeadAttributes: /properties/dealName, /properties/sourceReferrerId

18 January 2024 — Deal note authorship​

  • Deal notes gain the read-only writtenBy field, supporting up to 500 characters.
  • Removes collection-level GET and HEAD operations for /jsonapi/deal-notes.
  • Refreshes supporting schemas, including geometry types and the agreement-holder organisation relationship.

Compatibility: Use the available related-resource or individual-note operations instead of relying on the removed collection routes.

306 operations after this release · 0 added · 2 removed · 12 updated. Schema changes are counted separately below.

Endpoint details

Removed

  • GET /jsonapi/deal-notes
  • HEAD /jsonapi/deal-notes

Updated definitions

  • DELETE /jsonapi/deal-notes/{id}
  • DELETE /jsonapi/deal-notes/{id}/relationships/deal
  • GET /jsonapi/deal-notes/{id}
  • GET /jsonapi/deal-notes/{id}/deal
  • GET /jsonapi/deal-notes/{id}/relationships/deal
  • HEAD /jsonapi/deal-notes/{id}
  • HEAD /jsonapi/deal-notes/{id}/deal
  • HEAD /jsonapi/deal-notes/{id}/relationships/deal
  • PATCH /jsonapi/deal-notes/{id}
  • PATCH /jsonapi/deal-notes/{id}/relationships/deal
  • POST /jsonapi/deal-notes
  • POST /jsonapi/deal-notes/{id}/relationships/deal
Schema details — 15 added, 1 removed, 2 updated

Added schemas

  • Coordinate
  • CoordinateEqualityComparer
  • CoordinateSequence
  • CoordinateSequenceFactory
  • Dimension
  • Envelope
  • Geometry
  • GeometryFactory
  • GeometryOverlay
  • NtsGeometryServices
  • OgcGeometryType
  • Ordinates
  • Point
  • PrecisionModel
  • PrecisionModels

Removed schemas

  • WorkbenchLogType

Updated schemas and changed locations

  • AgreementHolderRelationships: /properties/organisation
  • DealNoteAttributes: /properties/writtenBy