Move a deal

POSThttps://api.norreach.app/v1/deals/{id}/move

Moves a deal to another stage, exactly like dragging it on the board: recorded in the person's timeline. If someone else moved it in the meantime the answer is 409 conflict with the stage it is in now — nothing changes.

deals:writeRole must allow: deals.moveSupports dry_runOperation id: move_deal

POST/deals/{id}/move

curl -X POST "https://api.norreach.app/v1/deals/{id}/move" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "qualified"
}'

Move a deal

{
  "object": "deal_move",
  "id": "6c7d8e9f-0a1b-4c2d-9e3f-4a5b6c7d8e9f",
  "from": "meeting",
  "stage": "qualified",
  "changed": true,
  "dry_run": false
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope deals:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

stageenumrequired

One of:newcontactedmeetingqualifiedwonlost

Response

200application/json— Move a deal

object"deal_move"required

idstring (uuid)required

An id (UUID).

fromstringrequired

stagestringrequired

changedbooleanrequired

dry_runbooleanrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`conflict`	That conflicts with the current state.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/deals/{id}/move

curl -X POST "https://api.norreach.app/v1/deals/{id}/move" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "qualified"
}'

Move a deal

{
  "object": "deal_move",
  "id": "6c7d8e9f-0a1b-4c2d-9e3f-4a5b6c7d8e9f",
  "from": "meeting",
  "stage": "qualified",
  "changed": true,
  "dry_run": false
}