Skip to main content

Changes the custom status of a deal

PUT/jsonapi/deals/{id}/status

Where id is the identifier of the deal. The target CustomStatusId must belong to the same org as the deal.

For client-credentials integrations, supply your assigned adviser identifier in the UserId header. See request headers and data access.

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

idinteger

format: int32

Request body

application/json

Request documentobjectDealStatusChangeRequest ↗
customStatusIdintegerrequired

format: int32

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request PUT "${API_BASE_URL}/jsonapi/deals/{id}/status" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json' \
  --header 'Content-Type: application/vnd.api+json' \
  --data @request.json

Create request.json (or requestBody in JavaScript) using the request schema above. The field descriptions and resource guide explain additional business rules.

Responses

OK

application/json

200 responseobjectDealStatusChangeResponse ↗
idinteger

format: int32

customStatusIdinteger

format: int32

statusNamestring · nullable

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.