Deals

Update Deal

Updates the deal with the given id.

PATCH

/crm/deals/{id}

Update Deal

curl --request PATCH \
  --url https://api.operating.app/v1/crm/deals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "closeDate": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "externalId": "<string>",
  "externalUrl": "<string>",
  "name": "<string>",
  "pipelineId": "<string>",
  "pipelineStageId": "<string>",
  "probability": 123,
  "projectId": "<string>",
  "value": 123
}
'

{
  "data": {
    "closeDate": "<string>",
    "createdAt": "<string>",
    "currency": "<string>",
    "description": "<string>",
    "externalId": "<string>",
    "externalSystemName": "<string>",
    "externalUrl": "<string>",
    "id": "<string>",
    "name": "<string>",
    "pipelineId": "<string>",
    "pipelineStageId": "<string>",
    "probability": 123,
    "projectId": "<string>",
    "updatedAt": "<string>",
    "value": 123
  },
  "meta": {}
}

Deals represent the sales opportunities of the company. They are linked to projects for staffing purposes.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

Body

closeDatestring | null

The close date of this deal.

currencystring | null

The ISO 4217 currency code of this deal. E.g. USD or EUR.

Required string length: 3 - 3

descriptionstring | null

A description of this deal.

externalIdstring

An external identifier for your reference for this record. Must be unique for a record of this type. Not used by Operating.

externalUrlstring | null

A link displayed to users in relation to this deal.

namestring

The name of this deal.

pipelineIdstring

Id of the pipeline this deal is in.

pipelineStageIdstring

Id of the pipeline stage this deal is in.

probabilityinteger | null

The probability of this deal. Overrides the pipeline stage probability.

Required range: -9007199254740991 <= x <= 9007199254740991

projectIdstring

Id of the project related to this deal.

valuenumber | null

The value of this deal in the deal currency.

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team