Deal Enquiries

Settle or re-open an enquiry

PATCH/deals/{deal_id}/enquiries/{id}
enquiries:writeupdate_enquiryDeprecatedSunset 2027-06-30

{isSettled: true} settles the enquiry as the token's user; {isSettled: false} re-opens it. It answers the entity shape and emits the same webhooks. An unknown deal or enquiry returns 404 before the body is judged; a user_id in the body or query returns 422 missing. Deprecated: withdrawn on 2027-06-30. POST .../enquiries/{id}/actions/settle and .../actions/unsettle replace it; every answer carries a Link header with rel="successor-version" naming the first.

Path parameters

  • deal_idstring (uuid)Required#

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

  • idstring (uuid)Required#

    The enquiry's id.

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

  • isSettledbooleanRequired#

    True settles the enquiry, false re-opens it.

{
  "isSettled": true
}

Responses

200

Enquiry updated.

DealEnquiry
{
  "data": {
    "id": "6f7a8b9c-0d1e-4f2a-8b4c-5d6e7f809102",
    "deal_id": "9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "team_id": null,
    "message": "Is there capacity for a larger allocation?",
    "phone_number": "+44 20 7946 0000",
    "status": "settled",
    "settled_at": "2026-06-16T14:05:00Z",
    "settled_by": "1a2b3c4d-5e6f-4708-9a0b-1c2d3e4f5061",
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-16T14:05:00Z"
  }
}
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}/enquiries/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "isSettled": true
}'