Create a new Lead Event

POST

leadEvents

curl --request POST \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "type": "Cancel",
  "status": "Provide Customer With Three Options",
  "nextSteps": "<string>",
  "createdBy": 123,
  "currentStatusFor": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

{
  "doc": {
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123,
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { leadEvents } from '@drivly/commerce'

const sdk = new SDK(...)

const leadEvents = await sdk.leadEvents.create(data: leadEvents): Promise<leadEvents>

Authorizations

Authorization

string

header

required

Query Parameters

depth

number

number of levels to automatically populate relationships and uploads

locale

string

retrieves document(s) in a specific locale

fallback-locale

string

specifies a fallback locale if no locale value exists

Body

application/json

Response

200 - application/json

The response is of type object.

curl --request POST \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "type": "Cancel",
  "status": "Provide Customer With Three Options",
  "nextSteps": "<string>",
  "createdBy": 123,
  "currentStatusFor": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

{
  "doc": {
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123,
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

POST

leadEvents

curl --request POST \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "type": "Cancel",
  "status": "Provide Customer With Three Options",
  "nextSteps": "<string>",
  "createdBy": 123,
  "currentStatusFor": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

{
  "doc": {
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123,
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

Usage with the Drivly SDK

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { leadEvents } from '@drivly/commerce'

const sdk = new SDK(...)

const leadEvents = await sdk.leadEvents.create(data: leadEvents): Promise<leadEvents>

Authorizations

Authorization

string

header

required

Query Parameters

depth

number

number of levels to automatically populate relationships and uploads

locale

string

retrieves document(s) in a specific locale

fallback-locale

string

specifies a fallback locale if no locale value exists

Body

application/json

Response

200 - application/json

The response is of type object.

curl --request POST \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "lead": 123,
  "type": "Cancel",
  "status": "Provide Customer With Three Options",
  "nextSteps": "<string>",
  "createdBy": 123,
  "currentStatusFor": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}'

{
  "doc": {
    "lead": 123,
    "type": "Cancel",
    "status": "Provide Customer With Three Options",
    "nextSteps": "<string>",
    "createdBy": 123,
    "currentStatusFor": 123,
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "message": "<string>"
}

Authorizations

Query Parameters

Body

Response

Developers

Authorizations

Query Parameters

Body

Response