Skip to main content
POST
Create a deal

Authorizations

Authorization
string
header
required

API key from Settings > Developer. Format: alva_sk_...

Body

application/json

Fields marked "required" must be provided; all others are optional. In the interactive playground (the "Test Request" panel) the JSON body is fully editable — type over any value and delete the properties you don't need. Blank fields are ignored, so only the values you provide are sent.

name
string
required
companyId
string<uuid>
required

Must be an existing company in your account

ownerId
string<uuid>
required

User ID of the deal owner

primaryContactId
string<uuid> | null
stage
enum<string>
Available options:
discovery,
qualification,
proposal,
negotiation,
closed_won,
closed_lost
methodology
enum<string>
Available options:
meddpicc,
bant,
spiced
value
string | null

Decimal value e.g. "50000.00"

probability
string | null

0-100

expectedCloseDate
string<date-time> | null
notes
string | null
customFields
object

Response

Deal

success
boolean
Example:

true

message
string

Human-readable confirmation of the action.

data
object
resource
string