---
title: "Raise a clarification question against a record"
method: POST
path: "/api/Clarification/requestclarification"
tags: ["Clarification"]
---

# Raise a clarification question against a record

`POST /api/Clarification/requestclarification`

## Request

- Base URL: `https://apidocs.cflowapps.com` (the document declares no server; this is the origin it was published from)
- URL: `https://apidocs.cflowapps.com/api/Clarification/requestclarification`
- Auth: API key in header `X-Api-Key` and API key in header `X-User-Key`
- TypeScript: <https://skmtc.dev/cflowapps/apis/cflow-public-api/docs/api/Clarification/requestclarification/post.ts> (a function with typed inputs; its response is checked against the schema)

Sample request:
            
    POST
    {
         "WorkflowName":"Test Workflow",
         "StageName":"Manager Approval",
         "RecordId":"10",
         "ClarifyToUser":["john.doe"],
         "Question":"Could you confirm the invoice amount?"
    }

## Request body

- RaiseClarificationDto
  - `workflowName` string, required: Name of the workflow
  - `stageName` string, required: Name of the stage
  - `recordId` integer, required: Record Id
  - `clarifyToUser` string[], required: Username of the person the clarification is being asked to
  - `question` string, required: Clarification question to raise

## Response `200`

Return status of the request

- ClarificationResDto[]
  - `clarifyId` integer: Id of the newly raised clarification
  - `clarifyToUserFullName` string, nullable: Full name of the user the clarification was sent to
  - `email` string, nullable: Email address of the user the clarification was sent to
  - `workflowDispName` string, nullable: Display name of the workflow
  - `userFullName` string, nullable: Full name of the user who raised the clarification

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Resource not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/cflowapps/apis/cflow-public-api.md) - [All operations](https://skmtc.dev/cflowapps/apis/cflow-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cflowapps/apis/cflow-public-api/revisions/af0dadd0ad10?raw)