Skip to content
em sa em sa

Move Deal

POST
/api/pipeline/deals/{deal_id}/move
 
curl --request POST \
  --url https://example.com/api/pipeline/deals/example/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to_stage_id": "example", "org_id": "example" }'

Move a deal to a different pipeline stage.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
MoveDealRequest
object
to_stage_id
required
To Stage Id
string
org_id
required
Org Id
string
Example generated
{
  "to_stage_id": "example",
  "org_id": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
StageAssignmentResponse
object
deal_id
required
Deal Id
string
stage_id
required
Stage Id
string
stage_name
required
Stage Name
string
assigned_at
required
Assigned At
string
Example generated
{
  "deal_id": "example",
  "stage_id": "example",
  "stage_name": "example",
  "assigned_at": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}