This API allows users to create enquiries. Each location requires a unique API key for authorisation. Users can utilise this API submit new enquiries.
This API documentation is intended for developers and can be used to build custom solutions. If you are not a developer, please visit website enquiries page in dashboard for simpler options.
Authentication
⭐ To create a enquiry, each request must include an API key specific to the care location. The API key should be included in the request header.
Requirements
⭐ API Key of the care location.
Instructions to find API Key
Login in to your Carerota account.
Navigate to the Locations module and copy the API Key from the Profile tab.
Create Enquiry
Request Method: POST
URL : https://api.carerota.co.uk/api/add/enquiry
Headers
Field | Type | Description |
x-api-key | String, required | API key to care home identification |
Content-Type | application/json |
|
Parameters
Field | Type | Required | Description |
title | Enum ['Mr','Ms','Miss'] | Yes | Care seeker title |
first_name | String | Yes | Care seeker's first name |
last_name | String | Yes | Care seeker's last name |
String | Yes | Care seeker's email | |
phone | String | No | Care seeker's phone |
referrer | Enum - Send any one ['Google Business', 'Facebook', 'Own Website'] | Yes | Source of enquiry |
type | Enum - Send any one ['Callback', 'Care', "Job", "Tour"] | No | Type of enquiry. If provided, an email will also be sent to the address specified in the email settings. |
whos_need_care | Enum - Send any one ['Myself', 'A parent', 'A partner', 'Another family member', 'A friend', 'A client'] | No | Send who needs care |
type_of_care | Enum - Send any one ['Older person residential', 'Older person residential dementia', 'Older person nursing', 'Older person nursing dementia', 'Other types of care', 'Other'] | No | Send type of care required |
tour_type | Enum - Send any one ['Onsite', 'Remote'] | No | Send tour type if enquiry type is Tour |
preferred_date_for_tour | String in yyyy-mm-dd format EG: 2024-09-01 | No | Send date if enquiry type is Tour |
preferred_time_for_tour | String in HH:mm:ss format EG: 13:00:00 | No | Send date if enquiry type is Tour |
Validation rules
sometimes: Key in not mandatory, add only if required.
required: Key is mandatory
Example Request Headers
{
"x-api-key": "Location API KEY",
"Content-Type": "application/json
}
Example Request Body
{
"title": "Mr",
"first_name":"Joe",
"last_name":"Bloggs",
"email": "[email protected]"
"referrer" : "Google Business"
}
Example Response Body
{
"status": "success",
"message": "Enquiry created successfully!"
}