Skip to main content
PATCH
Update a lead

Authorizations

Authorization
string
header
required

An organization API key, created in Settings → Integrations → API keys. Keys start with mk_live_. Marro stores only a hash of a key, so it is shown once, when it is created: copy it then. Revoking a key ends its access at once. To replace a key without downtime, create the new one, switch your server to it, then revoke the old one. Changes made with a key appear on the lead’s timeline as made by the person who created the key, via the API. Scopes: objects.records.read (Read custom objects), objects.records.write (Create and update custom-object records), objects.records.delete (Delete custom-object records), leads.read (Read leads), leads.write (Create and update leads), leads.capture (Capture leads), crm.records.read (Read customers and opportunities), crm.records.write (Create and update customers and opportunities), reports.read (Read reports), money.read (Read products, quotes, invoices and payments), money.write (Create quotes and invoices and record payments), agent.tools (AI agent tools (MCP)).

Scopes

leads.write

Path Parameters

leadId
integer
required

The lead’s ID.

Required range: x >= 1

Body

application/json
fields
object

Only the fields to change, by key. Send null to clear a field.

stageId
integer

A stage of another pipeline moves the lead into that pipeline.

Required range: x <= 2147483647
pipelineId
integer

Moves the lead to this pipeline, at stageId (one of its stages) or its starting stage.

Required range: x <= 2147483647
branchId
integer | null

Moves the lead to this branch (IDs from GET /api/v1/branches), or null for no branch. Needs a key that can assign leads. A new owner (assigned_to) in another branch takes the lead to their branch unless a branchId is sent.

Required range: 0 < x <= 2147483647

Response

The lead after the change.

lead
object
required