Deals

Set the deal's custom status

POST/deals/{id}/actions/set-custom-status
deals:writeset_custom_status_deal

Sets the deal's custom status to custom_status_id, one of the organisation's statuses or null to clear, and returns the deal. An unknown id returns 422 exists. The same status again is written again: the previous status becomes that status, and it notifies and emits as any change. With notify=true, participants get an in-app notification and the classified-investor audience an email after commit (no email for drafts). dry_run shows the result without saving. Emits deal.custom_status_changed. Setting the previous status undoes it. Replaces PATCH /deals/{dealId}/custom-status.

Path parameters

  • idstring (uuid)Required#

    The deal's id, a uuid. An unknown id, or a deal the token can't see, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DealSetCustomStatus

  • custom_status_idstring | nullRequired#

    The id of one of the organisation's custom statuses, or null to clear the deal's custom status. Required.

  • notifyboolean#

    Notify the deal's participants in the app and email the deal's classified-investor audience once the change is saved. No email goes out while the deal is a draft.

    Default: false
{
  "custom_status_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "notify": true
}

Responses

200

The deal, with its new custom status.

Deal
{
  "data": {
    "id": "f6071829-3a4b-4c5d-9e6f-8091a2b3c4d5",
    "name": "Series B — Acme Robotics",
    "status": "published",
    "external": false,
    "external_id": "CRM-2026-0042",
    "summary": "Late-stage growth round in autonomous logistics.",
    "description": "<p>Acme Robotics is raising a Series B.</p>",
    "currency": "USD",
    "min_investment": 25000,
    "structure": "direct",
    "sub_structure": "equity",
    "type_details": {
      "sector": "information_technology",
      "growthStage": "growth"
    },
    "sponsor": "Acme Capital",
    "show_funding_secured": true,
    "allow_questions": false,
    "request_further_docs": false,
    "available_from": "2026-07-01T00:00:00+00:00",
    "available_to": "2026-09-30T23:59:59+00:00",
    "transaction_workflow_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
    "investor_engagement_enabled": true,
    "active_tranche_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "drafted_at": "2026-06-15T10:30:00+00:00",
    "approval_started_at": "2026-06-16T09:00:00+00:00",
    "approved_at": "2026-06-17T09:00:00+00:00",
    "published_at": "2026-06-18T09:00:00+00:00",
    "rejected_at": null,
    "retired_at": null,
    "tabs": [
      "deal",
      "documents",
      "video"
    ],
    "image_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "sponsor_image_id": null,
    "video_id": "76979871",
    "custom_status_id": null,
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-18T09:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/deals/{id}/actions/set-custom-status\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "custom_status_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "notify": true
}'