Documentation

API Documentation

RESTful API documentation for developers

Quick Info
Base URL
https://engage.lotsmcp.com
Authentication

API Key (Bearer token or X-API-Key header)

Total Endpoints

14

Getting Started

Authentication

All API requests require authentication using an API key. You can create an API key from your dashboard.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://engage.lotsmcp.com/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id

opportunities

GET
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id

Get opportunity

lotsengage_get_opportunity

Get one thread, its current reply, and whether it was posted.

POST
/api/v1/lotsengage/projects/:project_id/opportunities/import

Import opportunities

lotsengage_import_opportunities

File up to 50 threads. Each row reports created, updated, or rejected. A repeated URL updates the same thread and does not wipe a reply already handed, approved, or posted.

GET
/api/v1/lotsengage/projects/:project_id/opportunities

List opportunities

lotsengage_list_opportunities

List threads in a project. Filter with platform, fit, or status.

POST
/api/v1/lotsengage/projects/:project_id/opportunities

Save opportunity

lotsengage_save_opportunity

File one community thread. The same URL updates the same row and does not reopen a thread that is already handed, approved, or posted. platform is reddit, quora, hackernews, forum, facebook_group, or other. fit is strong, partial, or poor. rules is answer_only, disclose_ok, promo_banned, or unknown.

POST
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id/skip

Skip opportunity

lotsengage_skip_opportunity

Mark a thread as not worth an answer. A skipped thread is not drafted again. reason is required.

projects

POST
/api/v1/lotsengage/projects

Create engage project

lotsengage_create_project

Create the product to represent in communities, or return the existing project when this owner already used that name. A repeat does not overwrite the saved offer or disclosure line.

GET
/api/v1/lotsengage/projects/:project_id

Get engage project

lotsengage_get_project

Get one product plus counts of ready replies, handed replies, approved replies, and posted threads.

GET
/api/v1/lotsengage/projects

List engage projects

lotsengage_list_projects

List the products this owner represents in communities.

PATCH
/api/v1/lotsengage/projects/:project_id

Update engage project

lotsengage_update_project

Change the product name, site, offer summary, or disclosure line.

queue

GET
/api/v1/lotsengage/projects/:project_id/queue

Get engage queue

lotsengage_get_engage_queue

Start every community run here. Returns replies handed to the user, replies approved but not posted, ready replies not yet handed, then at most 3 found threads worth drafting. Skipped, declined, posted, and poor-fit threads are omitted.

replies

POST
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id/handed

Mark reply handed

lotsengage_mark_handed

Record that the current ready reply was given to the user. reply_id, when sent, must be that current reply.

POST
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id/posted

Mark thread posted

lotsengage_mark_posted

Record the live URL after the reply is public. posted_by=agent is rejected unless this reply was approved. posted_by=user records a post the person made. A second call returns the original URL.

POST
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id/decision

Record reply decision

lotsengage_record_decision

Record the user's decision on the current ready reply. decision is approved or declined.

POST
/api/v1/lotsengage/projects/:project_id/opportunities/:opportunity_id/replies

Save reply

lotsengage_save_reply

Save the prepared reply for one thread. A product mention requires discloses_ownership and the project disclosure line. promo_banned rejects a product mention. The previous ready reply is superseded.

API Documentation | Lots Engage