Skip to main content
POST
Create 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).

Body

application/json
fields
object
required

Values by field key. name and phone are always required, plus any field the organization requires on create. source takes a source ID and assigned_to a user ID; without an owner the organization’s assignment rules decide.

stageId
integer

Defaults to the starting stage of the lead’s pipeline. A stage names its own pipeline.

Required range: x <= 2147483647
pipelineId
integer

Defaults to the organization’s default pipeline. With a stageId, the stage must be one of this pipeline’s.

Required range: x <= 2147483647

Response

The new lead.

lead
object
required