Write Event

Create an event in an existing lead. An event represents any interaction that the caller wants to do in an existing lead.
Currently, only text messages are supported.

Example:
To write a message in the lead with the ID "jPlz8TM628rzyCRPqrtcvm", send an authenticated POST request to the URL:
https://api.yelp.com/v3/leads/jPlz8TM628rzyCRPqrtcvm/events with the following request body:

{
    "request_content": "The text message you want to send",
    "request_type": "TEXT"
}

For the above request, a successful POST call will return a 201 created response.

📘

This endpoint is part of the Leads API, visit Leads API to learn more.

Path Params
string
required

The Yelp Lead ID

Body Params

Request body for creating an event.

string
required

The actual content of the event. This must be a non empty string.

string
enum
required

The content type of the event. Only "TEXT" is supported right now.

Allowed:
Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json