---
id: suggestion-failed
title: "Mark suggestion as failed"
description: "Report that a suggestion execution failed. The suggestion can be retried by approving it again."
sidebar_label: "Mark suggestion as failed"
hide_title: true
hide_table_of_contents: true
api: eJztWVlz4zYS/isovCSpIiX6mOyO3hyPt+JUkpnykWTXUsktokUiQwIcAJStqPjftxqgJFLSjI/s8bD7IkMC0N3o4+vDKy7QpkZWTmrFR/wKK20cczk4BszWWYaWthg+Ylr71RxkgWLAbnLsHkhBsRkyg85IFGy2ZFBVRi+kyph0DDKQasAjris0QDcuBR/xLYFRoMsj7iCzfHTHrzd7fBJxi2ltpFvy0d2KzxAMmrPa5Xx0N2kmEa/AQIkOjfUHJD2mApfziCsokY84pJ6rw/KSuNg0xxL4aMXdsqJ964xUGW8ibvBTLQ0KPnKmxmhHRfTuQItJhyW7fEfPwkcoq4LoPP79j7/89e3Z7FxczHkTHZRF/mkJOprfFcDeZkfHJ2sBJoEaWvedFkvitiU+h8JixFOtHCpHe1BVhUy9fYa/W+K22pdTz37H1PGIV4as6SRa2t24yNSgrQt36Maut9E5puef8bXBHg9bpyla2yE907pAUHu0f83R5WiYy7HjvP4+ChQ9lZGSm4iXaC1kuG+RXdpnzNZlCWbJ2it9A3wHFpksIUNWVwIcCtbKPa+LYjkgCwt0IAv7tI7OhJC0hIK1dyKiljOwDFgh1UfmtH9l0DrF24ernkArXtVFMW3dgI947lxlR8NhJl1ezwapLofaZMNyGUMlY4tmIVMc0qXh6TFvmibiTjr/tou1KoPtaNPvG7SVVjZY6ThJ6M++14YY79ia5PwXuZ8UTxuOZKiV/FS/IIAibos6e4ZT1E7HGSqCNxTs9urHeG4kKlEsGVHo8wiOEQudfkQzlwXGM7AYe68hngFhpoQw0+e+rAKDyr0EnLh14Gp7iDyquiQUrlCJ8EvAcw/R3k5+tUFtg2QVv8THyuPL5JCQaW28lIFzX7o1rybiqUFS43S2fN7bISOiPm+1V31M9D2tY+I2m8Q2BaXQxP4+MdYPCs1LeGrD7NKSsj33B1kULeCgF2EuH/u8vY3j4AAdxqlWcylQpV0AUnU5Q7PH/XxzltlUG2QzdA+IiiUMlGBHPYbJ4O1xs0PhaYTrfCeAppdQvGmLwj+JXdcV1QqW/QTmo9APOxq+9e/z995tnJzNttDoNCGWLhbIzn+5iI+T42/jo+OTUw+PJToQ4A6GfV/SnyDNpcLY6bgMS7a+zOa6i//a7KCiwUpb6bRZEvk9AOQRnxlQac5HfC4fh+kCt1JyAr3aopk+X9Tv6xJUjEI6mBU+XNuSZUcuByZDN12gseHicRJDUUmFJ4Ojt/ucp951sqcF+OH6/c/s2uOp141BJZDsz+57BO+ZVF5xt5feGv/P7P+LmX1tdxRTcIdUN9empB1Omth73jsK/4cc1Q4Qswewa4DsG0vVRdGs04d9FdMLuuvrB0b7fev54E3exEdvuhnmGWxiJ8t9XudEgDjRrnVQVofYncbJtzdHx6OTZJQkgyRJ/kHMW+95PfMfwbrWB1/Ov2P1TpMVCrnT337br93OC0mpDo3xqNGWekzUHsalWkAhBZOqql3ESmkt+eoW3yJKkrWC2uXayD9QMPBBMxirsboKzss8jaBQz8ey2iIDJuR8jqFkyKHC0Vjd399TcThWq7FibOzVN+YjNua/bGhcEIkxj8KJQJDO3K3YeA0H4c5MiyUra+tYDguKtdAdsRaeluwrgXM001o5WXw15qyZjFXjpRirl5SvWuH7ue9Ov4wL1w6UACN21D3g3b7wri3dzrUg5/BH+RboJnvwuj29dTipHGYHyovvb24+tAUaS7VA9jUOskHETpOEPo7o44Q+Tr/pudxpkvhCRjwDadd52yAInw7Da+ly341nIDYA16xf+iT565zmGAeKmMCGLu9Cu2BXWzbPzxh7KM5gpmu3Zdbnc5MHHyOXJyQsoaBwR8H865UDqVBsYqpbJFB8Pp14D0fTZ93Ik2vVavf9JnA70B5sHrQTcxsbdTMgGANLHnHqSQ5mxj7TLyi/4xdPxm2I2LZFnQR4e3MI3q7RLNDswZtUwkezyhgoJq2tkemQzs4+XDIrg6u+un/9b0WzwcqgReVf5pNzhamcy5TZjiJ6bvvmBZF9xsrPx3bbooHDzKcCGwQIfKmZrM1OYNKzjIJiGg5NsedlzxFnZiTOI5b78nsj0wuw4bIVgbWOsnH0fxtKnClWK3ysfEvdyqVT3zuLtQ8GfQxa/w5NU65pqlpp64OKZo4jPuzMEoar7hi0GW7LMjtcSdEMN/18oB6mqbUpOrUlVHJApVpVgCPooirTzxnXTbXvMIKjdge1Gx0RofX800eyP0Ttll/8bV39/PDrja9VKJKutjPMi231e6gx2TQSYXS6MdHTxXuvdv/zhbVUc02Utn3c0SAZJHxbfJ2FSc2lR8Um8nYrwaNGOyim3rpbO4NlGwvtNPQbGPoPDPFbQzp8dMOqAKl8TUtesmq97q47weIRH+2O37eOR7uyM0uaRDwnBx7d8dWKBga3pmga+vlTjdSr300ivgAjKYy9fwppab2daH9WNV9ftZj7DTs8xz/4snUWU5TDFlDU9I1H/CMud/+xQBn61eLszSRfIY0UvJk0Ec8RBA2y7lbtxnngGt+EhL++uJey6AXhxlmaYuW+eHbSQZ0P769vKIjbfzOUPllwAw+U6uAhCKmrYHMav9BvK16AyuoQoYEmxQ70EWMHIbpFdF8Nq1U4caM/omqajVYcfee+CPgnkeZcnQ==
sidebar_class_name: "post api-method"
info_path: docs/api/action-items
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Mark suggestion as failed"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/action_item/{actionItemId}/suggestions/{id}/failed"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Report that a suggestion execution failed. The suggestion can be retried by approving it again.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"actionItemId","schema":{"type":"string"},"required":true,"description":"The action item ID.","example":"xYz789AbCdEf"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The suggestion ID.","example":"sUg123AbCdEf"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"execution_result":{"type":"object","description":"Result of a suggestion execution.","properties":{"success":{"type":"boolean","description":"Whether the execution succeeded.","example":true},"message":{"type":"string","description":"A summary message.","example":"Base image updated successfully."},"details":{"type":"object","description":"Additional details, such as a link to the resulting PR.","example":{"pull_request":"https://github.com/org/my-api-service/pull/42"}}},"title":"ExecutionResult"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The failed suggestion.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique suggestion ID.","example":"sUg123AbCdEf"},"slug":{"type":"string","description":"Auto-generated URL-friendly slug.","example":"update-dockerfile-base-image"},"action_item_id":{"type":"string","description":"The parent action item ID.","example":"xYz789AbCdEf"},"status":{"type":"string","enum":["pending","approved","applied","failed","rejected","expired"],"description":"The current status.","example":"pending"},"created_by":{"type":"string","description":"The agent that created the suggestion.","example":"security-scanner-agent"},"owner":{"type":"string","description":"The agent or system that will execute the fix.","example":"image-updater-agent"},"confidence":{"type":"number","description":"Confidence score between 0 and 1.","example":0.92},"description":{"type":"string","description":"A description of the proposed fix. Supports Markdown.","example":"Update the Dockerfile base image to resolve CVE-2026-1234."},"metadata":{"type":"object","description":"Machine-to-machine metadata for the executor.","example":{"repository":"org/my-api-service","branch":"fix/cve-2026-1234"}},"user_metadata":{"type":"object","description":"Human-editable parameters.","example":{"target_version":"20-alpine3.19"}},"user_metadata_config":{"type":"object","description":"JSON Schema for rendering `user_metadata` in the UI."},"execution_result":{"type":"object","description":"Result of a suggestion execution.","properties":{"success":{"type":"boolean","description":"Whether the execution succeeded.","example":true},"message":{"type":"string","description":"A summary message.","example":"Base image updated successfully."},"details":{"type":"object","description":"Additional details, such as a link to the resulting PR.","example":{"pull_request":"https://github.com/org/my-api-service/pull/42"}}},"title":"ExecutionResult"},"executed_at":{"type":"string","format":"date","description":"Date when the suggestion was executed.","example":null},"expires_at":{"type":"string","format":"date","description":"Expiration date.","example":"2026-05-15"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-04-06T12:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-04-06T12:30:00.000Z"}},"title":"Suggestion"}}}},"4XX":{"description":"Client error responses due to invalid input, missing parameters, or unauthorized access.\n\nRequest validation errors use a different shape:\n```json\n{\n  \"type\": \"ValidationError\",\n  \"errors\": [{ \"message\": \"body must have required property 'defer_until'\" }]\n}\n```\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Standard error response.","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"Machine-readable error code.","example":"bad_request"},"error":{"type":"string","description":"Short description of the error type.","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}},{"type":"object","description":"Request validation error response.","required":["type","errors"],"properties":{"type":{"type":"string","example":"ValidationError"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"body must have required property 'until'"}}}}}}]}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error.","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type.","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred on the server."}}}}}}}}
>
  
</StatusCodes>