Actions121
- Activity Actions
- Activity Type Actions
- Campaign Actions
- Channel Actions
- Contact Actions
- Custom Field Actions
- Deal Actions
- Distribution Rule Actions
- Item Category Actions
- Lost Reason Actions
- Meta Actions
- Organization Actions
- Pipeline Actions
- Product Actions
- Source Actions
- Stage Actions
- Tag Actions
- User Actions
- Webhook Actions
Deal → Create
AI-generatedSummary
Creates a deal in the specified pipeline and starting stage, with a required title. Optionally sets deal value, status, dates, related records, source metadata, and custom fields.
Inputs
- Title (required) — Deal or sales opportunity title.
- Pipeline ID (required) — ID of the pipeline where the deal will reside.
- Stage ID (required) — ID of the deal's starting stage within the pipeline.
- Fields to Set — Optional deal details: campaign, channel, person, organization, owner, and source IDs; currency, value, status, and temperature; expected close date; external sync code; on-hold flag and optional resume date; and custom fields supplied as JSON or key-value entries. Creation source metadata can include attribution fields such as UTM values, click IDs, session hash, landing page, and referrer; the API uses it to populate Source and Campaign when those are not sent. Date fields send only the YYYY-MM-DD date. On Hold Until is accepted only when Is On Hold is true.
Output shape
A single deal record returned by the API.
The source pack exposes only a signature-level view of the implementation, so the exact returned record fields and any response transformation are not shown.