Skip to navigation

Reject a lead

View as MarkdownOpen in Claude

Rejects the lead, optionally recording why.

Safe to retry, first write wins: re-rejecting an already-rejected lead keeps the comment that originally landed. An approved lead cannot be rejected.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

leadIdlongRequired
ID of the lead.

Request

This endpoint expects an object.
commentstring or nullOptional
Optional reason for the rejection.

Response

Lead rejected successfully.
successbooleanOptional
messagestring or nullOptional
dataobjectOptional
timestampdatetimeOptional

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error