Deal Enquiries

Settle an enquiry on a deal

POST/deals/{deal_id}/enquiries/{id}/actions/settle
enquiries:writesettle_deal_enquiryIdempotent

Moves an enquiry from open to settled, records the token's acting user as the settler, and returns it. Settling an enquiry that is already settled returns it unchanged and emits no event, so the first settler stays. A user_id returns 422 missing. Emits deal_enquiry.settled and sends nothing else. POST .../actions/unsettle undoes it. Replaces PATCH /deals/{deal_id}/enquiries/{id} with isSettled: true.

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.

Responses

200

The enquiry, now settled.

DealEnquiry
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "team_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "message": "string",
    "phone_number": "string",
    "status": "open",
    "settled_at": "2026-06-12T10:00:00+00:00",
    "settled_by": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10: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/{deal_id}/enquiries/{id}/actions/settle\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"