Create a lead
Creates a lead with the organization’s own field rules: required fields, option lists and formats are checked exactly as in the app. The lead starts in the starting stage unless you give one, and without an owner the organization’s assignment rules pick one. Phone number and email are unique per organization, so a retry of the same lead returns DUPLICATE_LEAD with the existing ID instead of creating a second.
Scope: leads.write.
Authorizations
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
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.
Defaults to the starting stage of the lead’s pipeline. A stage names its own pipeline.
x <= 2147483647Defaults to the organization’s default pipeline. With a stageId, the stage must be one of this pipeline’s.
x <= 2147483647Response
The new lead.