Update opportunity status

PATCH

/api/sites/{id}/opportunities/{opportunityID}

curl --request PATCH \
  --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opportunities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "status": "new" }'

Marks an opportunity saved, done, or dismissed. Requires site.manage_data.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

opportunityID

required

string format: uuid

Request Body ^required

Media type application/json

object

status

required

string

Allowed values: new saved done dismissed

Responses

200

Opportunity

Media type application/json

object

action_key

required

string

cited_evidence_ids

required

Array<string>

confidence

required

string

Allowed values: high medium

copy_params

required

object

key

additional properties

any

created_at

required

string format: date-time

detector_version

required

string

digest_key

required

string

evidence

required

Array<object>

object

detail_key

string

detail_params

object

key

additional properties

any

id

required

string

label_key

required

string

value

required

string

generated_at

required

string format: date-time

id

required

string format: uuid

impact_label_key

required

string

impact_value

required

string

kind

required

string

Allowed values: conversion traffic ai search setup

route_icon

required

string

route_label_key

required

string

route_params

object

key

additional properties

any

score

required

integer

score_breakdown

required

object

actionability

required

integer

effort

required

integer

evidence_fit

required

integer

freshness

required

integer

impact

required

integer

sample

required

integer

total

required

integer

urgency

required

integer

site_id

required

string format: uuid

status

required

string

Allowed values: new saved done dismissed

summary_key

required

string

title_key

required

string

type_key

required

string

updated_at

required

string format: date-time

Example

{
  "confidence": "high",
  "kind": "conversion",
  "status": "new"
}