Update lead

Updates lead text, follow-up data, comments or memo for a company-owned lead. A numeric identifier is treated as a lead ID; a nonnumeric identifier is looked up as a lead-history key. Follow-up changes require accepted history; text, comments and memo do not. Operations run sequentially, and HTTP 200 may contain a follow-up error in updates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company slug from the goBluebird URL.

string
required

Numeric lead ID or nonnumeric lead-history key. The resolved lead must belong directly to the authenticated company; this handler does not expand ownership to Reach companies. Unknown history keys are not safely guarded by this handler and may produce a server error.

Body Params

Include only the fields you want to update. The examples show separate operations; do not assume that all combinations are processed identically.

Fields processed in this order: lead_text, append_lead_text, followup, comment, memo, append_memo. The handler is not an atomic patch; inspect updates for individual results.

string

Nonempty replacement text. Stores edited_lead_text and its timestamp, then runs the lead refresh pipeline.

string

Nonempty text appended to the current agent_text with a newline, then processed through the same text refresh pipeline. Runs after lead_text when both are supplied.

followup
object

Follow-up updates require an accepted lead. Convenience statuses are normalized before processing. Company menu configuration and confirmation locks affect updates. Supplied keys are also recorded in the follow-up trail. Product operations run update, create, delete, then expected-to-final copying on transition to closed.

string

Creates a system comment prefixed with API: . Uses the accepted history ID when present, otherwise 0.

string

Creates or replaces the lead memo.

string

Runs after memo and writes the existing memo object text property plus a newline and this value. The model stores content as memo, not text, so the current implementation may replace existing memo content with a leading newline and the appended value. Use memo with the complete desired content when preservation is required.

Responses

400

The request was invalid.

401

Authentication is missing or invalid.

403

The API token is not authorized for this company or operation.

404

The requested resource was not found.

500

An unexpected server error occurred.

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