Update Deal

patch

https://api.partnerstack.com/v1/deals/{identifier}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identifier

string

required

Unique identifier of deal.

Body Params

account_name

string

length ≤ 255

Name of the account

amount

int32

Deal amount in cents

close_date

int32

Expected close date of deal as Unix timestamp in milliseconds

contact_first_name

string

length ≤ 255

First name of the account's contact

contact_last_name

string

length ≤ 255

Last name of the account's contact

meta

object | null

Key value pairs of additional data about the deal. Eligible keys are configured in your PartnerStack dashboard under the groups tab. First name, last name and company will be stored within meta and are all required on create. (e.g If you configure the question Company Size within a lead submission form assign meta as {company_size: 100})

partner_key

string

length ≤ 255

The unique key of the partner who owns this deal

stage

string

length ≤ 255

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

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Deal

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error