acknowledgeMyControlPrompt

Requires a customer (portal or buyer app) session.

Confirms the prompt an approval rule showed you at checkout (the CONTROL_CONFIRMATION_REQUIRED refusal), with a reason when it asks for one. Then place the order again before expiresAt.

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:

GraphQL

mutation AcknowledgeMyControlPrompt($input: AcknowledgeControlPromptInput!) {
  acknowledgeMyControlPrompt(input: $input) {
    acknowledgedAt
    confirmedCount
    decisionId
    expiresAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation AcknowledgeMyControlPrompt($input: AcknowledgeControlPromptInput!) {\n  acknowledgeMyControlPrompt(input: $input) {\n    acknowledgedAt\n    confirmedCount\n    decisionId\n    expiresAt\n  }\n}",
  "variables": {
    "input": {
      "acknowledged": true,
      "decisionId": "id",
      "documentId": "id",
      "documentType": "string"
    }
  }
}
EOF

Variables:

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

Response:

{
  "data": {
    "acknowledgeMyControlPrompt": {
      "acknowledgedAt": "2025-01-15T00:00:00Z",
      "confirmedCount": 0,
      "decisionId": "id",
      "expiresAt": "2025-01-15T00:00:00Z"
    }
  }
}

acknowledgeMyControlPrompt(
  input: AcknowledgeControlPromptInput!
): ControlPromptAcknowledgement!

Arguments

acknowledgeMyControlPrompt.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.