GuidesAPI Reference
API Reference
SupportPartnerStack Login

Update a deal

patch
https://api.partnerstack.com/api/v2/deals/

Updates the specified deal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

Unique identifier of deal. Can be external_key, if one configured for deal.

Body Params

Deals allow your partners to submit accounts they are working to your sales team to avoid channel conflicts and earn commissions for closed accounts.

Typically the Deals experience is handled through a CRM integration like Salesforce. However you may opt to use the Deals API to have PartnerStack interact with a custom data warehouse rather than directly with your CRM.

string | null

Name of the account

int32

Deal amount in cents

date

Expected close date of deal as YYYY-MM-DD

string | null

First name of the account's contact

string | null

Last name of the account's contact

string | null

The unique key of the customer associated with this deal.

string | null

Reference that can be used in place of the key.

field_data
object | null
fields
array of objects
fields
string
length ≤ 255

The unique key of the group in which this deals's partner is in

string | null

Reason for which the deal was lost.

meta
object | null
string | null
string
length ≤ 255

The unique key of the partner who owns this deal

string | null
enum

Source of the deal, either 'partner' or 'vendor', defaults to 'partner' if not specified

Allowed:
string
length ≤ 255

Current stage of this deal. Must appear in Deals Stage list found in group settings.

team
object | null

Details of team used in public API.

team_member
object | null

Details of team member used in public API.

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago