Deal Q&A

Ask a question on a deal

POST/deals/{deal_id}/questions
questions:writecreate_deal_question

Asks a question as the token's acting user and returns it with a Location. question is required, up to 5000 characters, and sanitised as HTML. A user_id in the body returns 422 missing. Emits deal_question.created, sends in-app notifications and an email to the deal's managers, and queues the platform's Q&A event, all after commit. DELETE /deals/{deal_id}/questions/{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 · DealQuestionCreate

  • questionstringRequired#

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

{
  "question": "What is the expected exit timeline?"
}

Responses

201

The question was asked.

DealQuestion
{
  "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",
    "question": "string",
    "reply_count": 1,
    "replies": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "question_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "reply": "string",
        "read": true,
        "created_at": "2026-06-12T10:00:00+00:00",
        "updated_at": "2026-06-12T10:00:00+00:00"
      }
    ],
    "unread_reply_count": 1,
    "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}/questions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "question": "What is the expected exit timeline?"
}'