Skip to content
digizeDocs

Move an opportunity to another stage

POST
/api/v1/opportunities/{id}/move
curl --request POST \
  --url https://digize.com/api/v1/opportunities/example/move \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "stageId": "example", "beforeId": "example" }'

Moves an opportunity to another stage of its pipeline, before another card or last. Won and lost stages close it; an open stage reopens a closed one.

Needs the crm:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 64 characters

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
stageId
required
string
>= 1 characters <= 64 characters
beforeId

The card it goes before; left out, it goes last.

string
>= 1 characters <= 64 characters

Example generated

{
  "stageId": "example",
  "beforeId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
id
required
string
name
required
string
pipelineId
required
string
stageId
required
string
status
required
string
Allowed values: open won lost abandoned
value
required

In the workspace currency’s minor unit.

number
contact
required
Any of:
object
id
required
string
name
required
string
email
required
string | null
company
required
Any of:
object
id
required
string
name
required
string
ownerId
required
string | null
source
required
string
expectedClose
required

A day on the workspace’s calendar, such as 2026-11-14.

string | null
notes
required
string
lostReason
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
activity
required
Array<object>
object
id
required
string
label
required
string
detail
required
string | null
at
required
string format: date-time

Example 

{
  "status": "open"
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

422

Section titled “422”

The Idempotency-Key was used with a different request.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}