API Reference
  1. Documentation

/deals

post
https://api.lime-go.com/v:version/deals
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

To create a deal in your application through the API.

When creating the deal via the API, you must include at least the deal's name and either its value or a list of products.

You'll also need to authenticate this request by adding header called "Authorization" with value set to "go-api:<ApiKey>", where <ApiKey> is the API key which you can find in Lime Go under "Settings" > "Integrations" > "Lime Go API-Keys"

DISCLAIMER:

LIMITATION: The given endpoint has a request limit 10 per minute to maintain performance. Exceeding this limit may result in throttling or denial of requests.

You can create deals ONLY with your application's default currency value.

Body Params
string

[Required] Deal Name

string
Defaults to NULL

Deal description

double

[Required if Products are not set] Value of the deal. Must be set if the deal doesn't contain any products

Pipeline
object

A pipeline object specifies which pipeline a deal should be assigned to and what status it should have within that pipeline. If either the pipeline name or status is left empty, the default pipeline and its default status will be assigned. If a pipeline name is provided but no status is specified, the default status for that particular pipeline will be applied.

string
Defaults to NULL

The company ID that the deal should be assigned to.

string
Defaults to NULL

The name of the source to which we aim to assign the deal. If the specified source does not already exist, it will be created automatically

int32
Defaults to null

The ID of the target list that we intend to assign to the deal

date
Defaults to YYYY-MM-DD

The date when the deal was submitted

date
Defaults to YYYY-MM-DD

The date when the deal was ordered

date
Defaults to YYYY-MM-DD

The date when the deal was won. This can only be set if the LostDate is not set

date
Defaults to YYYY-MM-DD

The date when the deal was lost. This can only be set if the WonDate is not set

Products
array of objects

[Required if Value is not set] An array containing the products ordered for the given deal. This must be specified if the deal's value is not set

Products
Tags
array of strings

An array of tags to be attached to a given deal. You can add a maximum of three tags to the deal, and the tag named "api integration" will be automatically included. If you provide three tags, "API integration-YYYY-MM-dd" (where YYYY-MM-dd is date of creation) will be the fourth one

Tags
int32
Defaults to 0

The probability of the deal

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago

Did this page help you?