Deal Enquiries

Raise an enquiry on a deal

POST/deals/{deal_id}/enquiries
enquiries:writecreate_deal_enquiry

Raises an enquiry as the token's acting user and returns it, open, with a Location. message is required, up to 5000 characters, and sanitised as HTML; phone_number is up to 50. A user_id in the body returns 422 missing. Emits deal_enquiry.created, sends in-app notifications and an email to the deal's managers, and queues the platform's enquiry event, all after commit. DELETE /deals/{deal_id}/enquiries/{id} 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.

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 · DealEnquiryCreate

  • messagestringRequired#

    The enquiry text. It is sanitised as HTML, and returns 422 filled when nothing is left.

  • phone_numberstring | null#

    A phone number to call back on.

{
  "message": "Is there capacity for a larger allocation?",
  "phone_number": "+44 20 7946 0000"
}

Responses

201

The enquiry was raised.

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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "message": "Is there capacity for a larger allocation?",
  "phone_number": "+44 20 7946 0000"
}'