Send “Dead Data” Campaign

Requests, and Responses

These are example Campaign Query requests and responses.

Create “Dead Data” Send (Request)

This is a POST request used to create a “Dead Data” campaign, specifying a schedule and assigning an adviser.

Request Example:

curl -X POST \
-H "Authorisation: Bearer <authentication_token>" \
--data 'data=[{"adviser":"First Name Last Name","forename":"Customer First Name","surname":"Customer Last Name","email":"Customer Email Address","sms":"Customer Mobile","crmnumber":"Company Reference Number"}]&schedule=weekly&assign=adviser' \
https://adviser.ai/api/v3/company/{companyId}/campaign/add/dead
  • URL endpoint: https://adviser.ai/api/v3/company/{companyId}/campaign/add/dead
  • Authorisation Header: Contains the Bearer token for authentication.
  • Data: An array of objects containing customer data, such as:
    • {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 company reference number.
  • schedule: Specifies the frequency of the campaign, in this case, “weekly.
  • “assign: Assigns the specified adviser to the campaign.
  • URL: The endpoint URL for creating a “Dead Data” campaign, with {companyId} replaced by the actual company ID.

Get “Dead Data” response

After the campaign creation request is processed, the API returns a JSON response. The response includes information about the campaign’s success and any errors encountered.

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: A unique identifier for the newly created campaign.
  • results: An object containing details of successfully created records. Each key corresponds to a unique identifier for a fact finder, with values detailing the customer’s information and the adviser’s details.
  • badrows: A list of any entries that failed during processing, along with reasons for the failure. In this case, the badrows array is empty, indicating no failures.

This API process facilitates the scheduling and assignment of “Dead Data” campaigns, providing a detailed response to track the success and status of the created records.