Skip to main content
PUT
Update the matching opportunity, or create it

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Query Parameters

match
string
required

The key that finds the opportunity to update; its value comes from the body

Allowed value: "crm_opportunity_id"

Body

application/json
account
string

Required: the id of the account the opportunity is on

amount
number

The deal's value

close_date
string<date>

YYYY-MM-DD

crm_opportunity_id
string

The opportunity's id in your CRM

description
string

Free text

fields
Fields · object | null

Custom field keys to values

name
string

The opportunity's name (required on a create)

owner
string

The owner's user id

stage
string

One of your stages (key or label) where your stage list is set up

type
string

New Business, Renewal, Expansion, ...

Response

Successful Response

id
string
required
result
enum<string>
required
Available options:
created,
updated
account
string | null

The id of the account the opportunity is on

account_name
string | null
amount
number | null
close_date
string | null
created_at
string | null
crm_opportunity_id
string | null
description
string | null
fields
Fields · object
is_closed
boolean
default:false
is_won
boolean
default:false
name
string | null
owner
string | null

The owner's user id

source
string | null
stage
string | null
type
string | null