Clarification

Raise a clarification question against a record

Sample request:

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

Request

Request body

workflowNamestring required

Name of the workflow

stageNamestring required

Name of the stage

recordIdinteger required

Record Id

clarifyToUserstring[] required

Username of the person the clarification is being asked to

questionstring required

Clarification question to raise

Response

Return status of the request

clarifyIdinteger

Id of the newly raised clarification

clarifyToUserFullNamestring nullable

Full name of the user the clarification was sent to

emailstring nullable

Email address of the user the clarification was sent to

workflowDispNamestring nullable

Display name of the workflow

userFullNamestring nullable

Full name of the user who raised the clarification

Changes

No recorded changes to this operation across all 1 revision of this API.