Skip to main content
POST
Mark an action started

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

actionId
string<uuid>
required
Example:

"0b6f2c1e-6d2a-4c3e-9a1f-5e8d7c4b3a21"

Response

The action after the request.

The action's status after the request.

status
enum<string>
required

The action's status, derived from its history: suggested: Research recommends it and nobody has acted on it yet. in_progress: Someone started it (POST .../start), or Jam is doing it (a draft or a code change is being prepared). sent: Outreach only: the pitch went out (reported by the customer or their agent, never sent by Jam). Waiting for the third party to act. done: Reported done, or Jam shipped it. Jam checks the page once; until that check passes the action stays done. verified: Jam's check found the change on the page (or the brand on the list). unverified: Jam's check did not find the change on the page. Fix it and POST .../checks to check again, or POST .../completion with the right URL. dismissed: Taken off the Plan by the customer. DELETE .../dismissal puts it back. superseded: A later research run no longer proposes it (the gap closed or another action replaced it). Hidden from the list unless includeSuperseded=true.

Available options:
suggested,
in_progress,
sent,
done,
verified,
unverified,
dismissed,
superseded