Pipeline Stages

Update Pipeline Stage

Updates the pipeline stage with the given id.

PATCH

/crm/pipeline-stages/{id}

curl --request PATCH \
  --url https://api.operating.app/v1/crm/pipeline-stages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dealProbability": 123,
  "externalId": "<string>",
  "name": "<string>",
  "orderNumberInPipeline": 123,
  "pipelineId": "<string>"
}
'

{
  "data": {
    "createdAt": "<string>",
    "dealProbability": 123,
    "externalId": "<string>",
    "externalSystemName": "<string>",
    "id": "<string>",
    "name": "<string>",
    "orderNumberInPipeline": 123,
    "pipelineId": "<string>",
    "triggersProjectCreation": true,
    "updatedAt": "<string>"
  },
  "meta": {}
}

Pipeline stages are the individual steps of the sales process. Each stage is part of exactly one pipeline and several deals can be in any one stage.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

idstringrequired

Body

dealProbabilitynumber

The probability of a deal at this stage. Integer between 0 and 100.

Required range: 0 <= x <= 100

externalIdstring

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

namestring

The name of this pipeline.

orderNumberInPipelinenumber

The order number of this stage in the pipeline. The specific number does not matter, but higher numbers are later stages.

pipelineIdstring

The id of the pipeline this stage belongs to.

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team