Mark Lead Event as read

post

https://api.yelp.com/v3/leads/{ID}/events/mark_as_read

Mark an existing lead event and all events before that as read.

Example:
To mark all events before and including the event ID "NJJQvyxvpk87NUpsm2y5Yw" as read at "2022-07-21T20:54:42+00:00", in the lead with the ID "loPSlzp6M628rzyCRPqrv3tC", send an authenticated POST request to the URL:
https://api.yelp.com/v3/leads/loPSlzp6M628rzyCRPqrv3tC/events/mark_as_read with the following request body:

{
    "event_id": "NJJQvyxvpk87NUpsm2y5Yw",
    "time_read": "2022-07-21T20:54:42+00:00"
}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Responses

code	description
INVALID_ID	"The ID provided is not valid"
VALIDATION_ERROR	"'event_id' is a required property"
VALIDATION_ERROR	"'Invalid-time-read-value' is not a 'date-time'"

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

code	description
UNAUTHORIZED_BUSINESS_MINIMUM_ADVERTISING	"You're not authorized to access this business as it does not meet minimum advertising requirements."
NO_BUSINESS_ACCESS	"You don't have access to this Business."

📘