Posts a customer note to one of the handle contact lead clusters

POST

/api/v1/websites/{website_id}/phone_identities/{handle}/lead_clusters/{lead_cluster_id}/notes

const url = 'https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities/example/lead_clusters/1/notes';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"description":"Running 10 minutes late","quick_reply":"reschedule"}'
};

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/websites/example/phone_identities/example/lead_clusters/1/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "Running 10 minutes late", "quick_reply": "reschedule" }'

Records a myGarage note from the customer as a note lead event on the lead cluster. The lead cluster must belong to the contact behind the handle. At least one of description and quick_reply is required, and a quick reply with no text uses its label as the description. Requires the garage:phone_identity permission.

Authorizations

Bearer

Parameters

Path Parameters

website_id

required

string

Website ID

handle

required

string

Pseudonymous handle

lead_cluster_id

required

integer

Lead cluster ID

Request Body

application/json

object

description

string

<= 1000 characters

Example

Running 10 minutes late

quick_reply

string

Allowed values: reschedule running_late question cancel

Example

running_late

Responses

201

Note created

application/json

object

integer

lead_cluster_id

integer

event_type

string

description

string

external_service

string

sent_by

string

quick_reply

string

nullable

created_at

string format: date-time

Example

{
  "id": 1,
  "lead_cluster_id": 2,
  "event_type": "note",
  "description": "Running 10 minutes late",
  "external_service": "my_garage",
  "sent_by": "customer",
  "quick_reply": "running_late"
}

404

Handle or lead cluster is unknown

application/json

object

error

string

Example

{
  "error": "lead_cluster_not_found"
}

422

No description or quick reply, an unknown quick reply, or the garage is not enabled

application/json

object

error

string

Example

{
  "error": "description_or_quick_reply_required"
}