API Reference

Create a deal

post
https://api.heymantle.com/v1/deals

Create a new deal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the deal

float

The monetary value of the deal

string

The currency code for the deal amount

string

The channel through which the deal was acquired

string

The specific source of the deal acquisition

date-time

The timestamp of the first interaction

date-time

The expected closing date

date-time

The actual closing date

string

The ID of the deal flow. If not provided, uses the default deal flow (isDefaultDealFlow=true) or the first active deal flow by displayOrder.

string

The ID of the deal stage. If not provided, uses the first stage of the resolved deal flow by displayOrder.

string

The ID of the customer

string

The domain of the customer when creating a deal with just a contact

string

The shopify domain of the customer when creating a deal with just a contact

string

The ID of the company

string

The ID of the app

string

The ID of the plan

ownerIds
array of strings

Array of owner user IDs

ownerIds
contactIds
array of strings

Array of contact IDs (alternative to contacts array)

contactIds
customer
object

Create or update a customer inline (alternative to customerId). Matches existing customers by domain or shopifyDomain.

contacts
array of objects

Create or update contacts inline (alternative to contactIds). Matches existing contacts by email. Contacts are linked to both the customer and the deal.

contacts
string

Additional notes about the deal

string

The ID of the affiliate

string

The ID of the partnership

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?