Brochure request example

Prev Next

An example brochure.create request for a brochure request (category 2). All names, contact details and messages are made up.

Who can use it: enquiry webhooks are available to Enhanced and Platinum subscribers. See Enquiry Webhooks Overview.

The fields outside categorySpecificData are the same for every type and are described in Enquiry Webhook Request. Every field listed below is always sent; if the information was not collected, its value is null.

Fields

Sent as brochure.create when someone requests a setting's brochure. Brochure requests are the enquiry type most likely to include the enquirer's postal address.

FieldTypeDescription
commentstring or nullThe enquirer's message, or the text of the brochure request. It can contain HTML or line breaks.
personNeedingCareNamestring or nullThe full name of the person who needs care, if the enquirer gave both a first name and a surname.
whoIsNeedOfCarestring or nullWho needs care, from the enquirer's point of view. One of the listed values below.
careNeededTypestring or nullThe type of care needed. One of the listed values below.
howSoonTypestring or nullHow soon care is needed. One of the listed values below.
stayLengthTypestring or nullWhether the stay is long-term or short-term. One of the listed values below.
fundingTypestring or nullHow the care will be paid for. One of the listed values below.
enquirerInterestedInATourstringYes if the enquirer said they would like a tour, otherwise No.

Example request

{
  "type": "brochure.create",
  "timestamp": "2026-11-03T10:26:10.344Z",
  "data": {
    "id": 12345680,
    "category": {
      "id": 2,
      "name": "Brochure Request"
    },
    "member": {
      "id": "123456",
      "name": "Example Care Home",
      "postcode": "AB1 2CD"
    },
    "group": {
      "id": "654321",
      "name": "Example Care Group",
      "postcode": "AB1 2CD"
    },
    "emailto": "manager@example.com",
    "emailfrom": "example@example.com",
    "entrydate": "2026-11-03T10:26:07.000Z",
    "bodycontent": "Example message text.",
    "firstname": "Example",
    "surname": "Name",
    "address1": "1 Example Street",
    "address2": null,
    "address3": null,
    "town": "Exampletown",
    "postcode": "AB1 2CD",
    "telephone": "01234 567890",
    "isAnonymised": "No",
    "categorySpecificData": {
      "comment": "Example message text.",
      "personNeedingCareName": null,
      "whoIsNeedOfCare": "A parent",
      "careNeededType": "Older person residential",
      "howSoonType": "1 - 3 months",
      "stayLengthType": "Permanent/Long-term",
      "fundingType": "Self funding (Private)",
      "enquirerInterestedInATour": "No"
    }
  }
}

Listed values

These fields contain one of the values below, or null. N/A can also appear, mainly on call enquiries. We may add values in future, so make sure your system accepts values it does not recognise.

whoIsNeedOfCare

  • Myself
  • A parent
  • A partner
  • Another family member
  • A friend
  • A client

careNeededType

  • Older person residential
  • Older person residential dementia
  • Older person nursing
  • Older person nursing dementia
  • Other types of care
  • Not sure

howSoonType

  • Immediately (1 day - 1 week)
  • 1 week - 1 month
  • 1 - 3 months
  • 3 - 6 months
  • 6 months +

stayLengthType

  • Permanent/Long-term
  • Respite/Short-term

fundingType

  • Self funding (Private)
  • Local Authority with Top-up
  • Local Authority
  • NHS Continuing Healthcare (CHC)
  • Not sure