create lead event by service

Deprecated

POST

/api/v1/lead_events/{service}/create

const url = 'https://dashboard.dealerstudio.com.au/api/v1/lead_events/example/create?leadId=123456&messageDetail=%7B%22contactType%22%3A%22SMS%22%2C%22description%22%3A%22Hello%2C%20my%20name%20is%20.........%22%2C%22sentDate%22%3A%222023-08-18T10%3A39%3A00.000%22%2C%22sentBy%22%3A%22Client%22%2C%22linkStopCommunication%22%3A%22https%3A%2F%2Funsubscribe.impel.io%2Fconversation%22%2C%22linkReplyAsAssistant%22%3A%22https%3A%2F%2Fassistant.impel.io%2Fconversation%22%7D';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://dashboard.dealerstudio.com.au/api/v1/lead_events/example/create?leadId=123456&messageDetail=%7B%22contactType%22%3A%22SMS%22%2C%22description%22%3A%22Hello%2C%20my%20name%20is%20.........%22%2C%22sentDate%22%3A%222023-08-18T10%3A39%3A00.000%22%2C%22sentBy%22%3A%22Client%22%2C%22linkStopCommunication%22%3A%22https%3A%2F%2Funsubscribe.impel.io%2Fconversation%22%2C%22linkReplyAsAssistant%22%3A%22https%3A%2F%2Fassistant.impel.io%2Fconversation%22%7D' \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

service

required

string

External Service (e.g., impel)

Query Parameters

data

object

leadId

required

integer

messageDetail

required

object

contactType

string

description

string

sentDate

string

sentBy

string

linkStopCommunication

string

linkReplyAsAssistant

string

Example

{
  "leadId": 123456,
  "messageDetail": {
    "contactType": "SMS",
    "description": "Hello, my name is .........",
    "sentDate": "2023-08-18T10:39:00.000",
    "sentBy": "Client",
    "linkStopCommunication": "https://unsubscribe.impel.io/conversation",
    "linkReplyAsAssistant": "https://assistant.impel.io/conversation"
  }
}

Responses

200

Successful lead event creation by service

401

Unauthorised with other permission

404

No lead found