Send a “Adviser Single”

Requests, and Responses

Create “Adviser Single” Send (Request)

This POST request is used to create a campaign for a single adviser, including specific customer details.

Request Example:

curl -X POST
-H "Authorisation: Bearer <authentication_token>"
--data "adviser=First Name Last Name&forename=Customer First Name&surname=Customer Last Name&email=Customer Email Address&sms=Customer Mobile&crmnumber=CRMNumber" \
https://adviser.ai/api/v3/company/{companyId}/factfinder/add/single
  • URL Endpoint: https://adviser.ai/api/v3/company/{companyId}/factfinder/add/single
  • Authorisation Header: Contains the Bearer token for authentication.
  • Data: URL-encoded form data including:
    • {adviser}: The name of the adviser.
    • {forename}: The first name of the customer.
    • {surname}: The last name of the customer.
    • {email}: The customer’s email address.
    • {sms}: The customer’s mobile number.
    • {crmnumber}: The CRM number for the customer.
  • URL: The endpoint URL for creating a single adviser campaign, with {companyId} replaced by the actual company ID.

Get “Adviser Single” Response

Upon successful execution of the campaign creation request, the API returns a JSON response that includes the campaign ID, the results of the data entries, and any failed rows.

Response Example:

{
    "campaign_id": "XXXXX",
    "results": {
        "XXXXX": {
            "adviser": "First Name Last Name",
            "reference": "Company Reference Number",
            "surname": "Customer Last Name",
            "forename": "Customer First Name",
            "email": "Customer Email Address",
            "sms": "Customer Mobile",
            "leadstatus": "",
            "leadgenerated_datetime": null
        }
    },
    "badrows": []
}
  • campaign_id: The unique identifier for the newly created campaign.
  • results: An object containing the details of the successfully created records. Each key corresponds to an identifier for a fact finder, with details like:
    • {adviser}: The name of the adviser.
    • {reference}: The CRM number.
    • {surname}: The last name of the customer.
    • {forename}: The first name of the customer.
    • {email}: The customer’s email address.
    • {sms}: The customer’s mobile number.
    • {leadstatus}: The status of the lead (if applicable).
    • {leadgenerated_datetime}: The date and time the lead was generated (if applicable).
  • badrows: A list of entries that failed to process, along with reasons for the failure. In the example provided, {badrows} is empty, indicating no failures occurred.

This API workflow allows for the creation of a single fact finder with customer data, while also providing detailed feedback on the operation’s success and any issues encountered.