Skip to main content
PATCH
/
actions
/
{id}
Update action item status
curl --request PATCH \
  --url https://server.promptwatch.com/api/v2/actions/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "id": "6ba7b820-9dad-11d1-80b4-00c04fd430c8",
  "projectId": "6ba7b821-9dad-11d1-80b4-00c04fd430c8",
  "type": "SETUP",
  "status": "todo",
  "severity": "high",
  "title": "Connect your sitemap",
  "description": "Add a sitemap so we can crawl your site.",
  "reasoning": "",
  "geoImpact": null,
  "data": {
    "type": "SETUP",
    "setupType": "SITEMAP",
    "status": "NOT_CONFIGURED"
  },
  "completedAt": null,
  "dismissedAt": null,
  "createdAt": "2026-06-01T12:00:00.000Z",
  "updatedAt": "2026-06-01T12:00:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

​
id
string<uuid>
required

Action item ID

Body

application/json
​
status
enum<string>
required

New status

Available options:
suggested,
dismissed,
todo,
in_progress,
done

Response

Default Response

​
id
string<uuid>
required

Action item identifier

​
projectId
string<uuid>
required

Project identifier

​
type
enum<string>
required

Action type

Available options:
WEBSITE_PERFORMANCE,
WEBSITE_HEALTH,
CONTENT_GAP,
REDDIT_SOCIAL,
SETUP,
UNTRACKED_PAGE,
UNTAPPED_PAGE,
OFFSITE_MENTION
​
status
enum<string>
required

Action item status

Available options:
suggested,
dismissed,
todo,
in_progress,
done
​
data
object
required

Type-specific payload (discriminated union on type). Drill-down keys: CONTENT_GAP → use data.promptId with GET /content-gap/prompts/{promptId}/latest; WEBSITE_HEALTH → GET /site-health (optional issueTypes filter).

​
createdAt
string<date-time>
required

Timestamp (ISO 8601)

​
updatedAt
string<date-time>
required

Timestamp (ISO 8601)

​
severity
enum<string> | null

Priority severity

Available options:
critical,
high,
medium,
low
​
title
string | null

Card headline

​
description
string | null

Card body

​
reasoning
string | null

Evidence trail for the suggestion

​
geoImpact
string | null

GEO visibility impact summary

​
completedAt
string<date-time> | null

Timestamp (ISO 8601)

​
dismissedAt
string<date-time> | null

Timestamp (ISO 8601)