Deals

Update the deal's settings

PATCH/deals/{deal_id}/settings
deals:writeupdate_deal_settingsIdempotent

Changes the communication and secondaries switches you send and returns all the settings; omitted switches keep their value. deal_id, entrepreneur, any other group, an unknown or wrong-group switch or a non-boolean value returns 422. dry_run shows the result without saving. Emits deal_settings.updated with the changed groups in changed_fields, only when something changed; sends no email. Sending the old values undoes it.

Path parameters

  • deal_idstring (uuid)Required#

    The deal's id, a uuid. An unknown deal, or one 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.

Request body

application/json, required · DealSettingsUpdate

  • communicationobject#

    Send only the switches you change.

  • secondariesobject#

    Send only the switches you change.

{
  "communication": {
    "enable_q_and_a": false
  },
  "secondaries": {
    "enable_secondary_investments": true
  }
}

Responses

200

The deal settings after the change.

DealSettings
{
  "data": {
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "communication": {
      "enable_due_diligence": true,
      "enable_enquiries": true,
      "enable_meet_management": true,
      "enable_q_and_a": true
    },
    "secondaries": {
      "enable_secondary_investments": true,
      "show_outside_availability_window": true
    },
    "entrepreneur": {
      "enable_delegate_deal_entrepreneur": true,
      "enable_delegate_all_investors_deal_entrepreneur": true,
      "enable_analytics_entrepreneur": true,
      "enable_bookbuilding_entrepreneur": true,
      "enable_deal_status_entrepreneur": true,
      "enable_documents_entrepreneur": true,
      "enable_due_diligence_entrepreneur": true,
      "enable_enquiries_entrepreneur": true,
      "enable_key_contacts_entrepreneur": true,
      "enable_meet_management_entrepreneur": true,
      "enable_per_deal_settings_entrepreneur": true,
      "enable_q_and_a_entrepreneur": true,
      "enable_transaction_manangement_entrepreneur": true
    }
  }
}
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 PATCH https://your-org-domain/kong/core/api/v2/deals/{deal_id}/settings\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "communication": {
    "enable_q_and_a": false
  },
  "secondaries": {
    "enable_secondary_investments": true
  }
}'