Approve, reject, or edit a single requirement suggestion
POST
/projects/{id}/roadmap-check/{checkId}/suggestions/{suggestionId}/action
const url = 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/action';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"action":"approve"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/action \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "action": "approve" }'Updates the row’s approval_status and (for edits) stores edited_payload
which overrides the AI’s defaults at apply time. Idempotent.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string format: uuid
Project UUID
checkId
required
string format: uuid
suggestionId
required
string format: uuid
Request Body required
Section titled “Request Body required ” Media type application/json
One of:
object
action
required
string
object
action
required
string
object
action
required
string
edited_payload
required
object
requirement_title
string
requirement_description
string
suggested_action
string
suggested_milestone_id
string | null format: uuid
suggested_milestone_title
string | null
existing_ticket_id
string | null format: uuid
Responses
Section titled “ Responses ”Updated suggestion row
Media type application/json
object
suggestion
object
Invalid action body
Not authenticated
Media type application/json
object
error
required
Human-readable error message
string
code
Stable machine-readable error code for client branching
string
fieldErrors
First validation message per field path
object
key
additional properties
string
issues
Structured validation issues (Zod)
Array<object>
object
path
required
string
message
required
string
retryAfter
Seconds until rate limit resets (429 responses)
number
reconnect
True if re-linking GitHub may fix the issue
boolean
Forbidden
Media type application/json
object
error
required
Human-readable error message
string
code
Stable machine-readable error code for client branching
string
fieldErrors
First validation message per field path
object
key
additional properties
string
issues
Structured validation issues (Zod)
Array<object>
object
path
required
string
message
required
string
retryAfter
Seconds until rate limit resets (429 responses)
number
Suggestion not found
Suggestion has already been applied and cannot be modified