Skip to main content
PATCH
Update a lead

Authorizations

Authorization
string
header
required

An organization API key, created in Settings → Connections → 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: leads.read (Read leads), leads.write (Create and update leads), leads.capture (Capture leads).

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

Response

The lead after the change.

lead
object
required