Skip to main content

acknowledgeControlPrompt

Requires at least one of the permissions inventory:stock_adjustment:create, payments:collection:create, payments:collection:update, payments:invoice:cancel, payments:invoice:create, payments:invoice:send, payments:payment:allocate, payments:payment:create, payments:payment:update, payments:payment:void, purchase:debit_note:create, purchase:grn:create, purchase:grn:update, purchase:payment:allocate, purchase:payment:create, purchase:payment:update, purchase:payment:void, purchase:purchase_invoice:create, purchase:purchase_order:approve, purchase:purchase_order:delete, purchase:purchase_order:update, sales:credit_note:create, sales:quote:delete, sales:quote:update, sales:sales_invoice:create, sales:sales_order:cancel, sales:sales_order:confirm, sales:sales_order:create, sales:sales_order:delete, sales:sales_order:deliver, sales:sales_order:ship, sales:sales_order:update, sales:shipment:create or sales:shipment:update.

Confirms the approval rule prompt you were shown (the CONTROL_CONFIRMATION_REQUIRED refusal), with a reason when a rule asks for one. It does not run the step: run the same step again before expiresAt and it goes ahead, recorded as confirmed by you. An agent can never confirm.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation AcknowledgeControlPrompt($input: AcknowledgeControlPromptInput!) {
  acknowledgeControlPrompt(input: $input) {
    acknowledgedAt
    confirmedCount
    decisionId
    expiresAt
  }
}

Variables:

{
  "input": {
    "acknowledged": true,
    "decisionId": "id",
    "documentId": "id",
    "documentType": "string"
  }
}

Response:

{
  "data": {
    "acknowledgeControlPrompt": {
      "acknowledgedAt": "2025-01-15T00:00:00Z",
      "confirmedCount": 0,
      "decisionId": "id",
      "expiresAt": "2025-01-15T00:00:00Z"
    }
  }
}
acknowledgeControlPrompt(
  input: AcknowledgeControlPromptInput!
): ControlPromptAcknowledgement!

Arguments​

acknowledgeControlPrompt.input ● AcknowledgeControlPromptInput! non-null input​

The refusal's decisionId and document, the person's reason (when a rule asks for one) and whether they ticked the rule's box.

Type​

ControlPromptAcknowledgement object​

An approval rule's prompt was confirmed. Run the same step again within the time shown; the confirmation is used once.