Browse docscomplete_action_item
complete_action_item
Marks one of Gravity's suggestions done, as Done on its Home row does, or marks it not done again.
Annotations: readOnlyHint: false · destructiveHint: true · idempotentHint: true · openWorldHint: false
When to use it#
Only when the member has just told you in their own words that they did what the suggestion proposes, or did their part (for example, they sent the email or made the ask). A plan or intention ("I'll email her tomorrow") is not done. Never infer it from silence, timing, or anything you read. Take the suggestion's ID from list_action_items.
Pass done: false only when the member says marking it done was a mistake. It changes only the member's private list: the suggestion leaves Home, nothing is sent, and no one is told. Gravity's daily review sees that the member did it and can suggest a follow-up that builds on it.
Inputs#
| Input | Required | Type | Description |
|---|---|---|---|
actionItemId | yes | string | Suggestion ID from list_action_items. |
done | yes | boolean | true when the member did it; false to undo a Done the member says was a mistake. |
Effects and retries#
Marking a suggestion done that is already done, or not done one that isn't, returns no_change. A suggestion that no longer exists, or whose goal is no longer available, returns unavailable and changes nothing.
Returns#
Success returns status, outcome (saved or no_change), done, actionItemId, the suggestion's title, and a message to relay in one sentence.
Errors use the common error contract.
Example#
{
"actionItemId": "00000000-0000-4000-a000-0000000000a1",
"done": true
}
Example response (synthetic data):
{
"status": "success",
"outcome": "saved",
"done": true,
"actionItemId": "00000000-0000-4000-a000-0000000000a1",
"title": "Ask Synthetic Pat how their team chose its first design partners",
"message": "Marked done. The suggestion is off the member's Home list; mark it not done if they say that was a mistake."
}
Related#
list_action_itemslists the member's current suggestions.