Opportunities

Update opportunity status

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

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

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/opportunities/{opportunityID}
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required
opportunityIDstring uuid required

Request body

status'new' | 'saved' | 'done' | 'dismissed' required

Response

Opportunity

action_keystring required
cited_evidence_idsstring[] required
confidence'high' | 'medium' required
copy_paramsobject required
created_atstring date-time required
detector_versionstring required
digest_keystring required
generated_atstring date-time required
idstring uuid required
impact_label_keystring required
impact_valuestring required
kind'conversion' | 'traffic' | 'ai' | 'search' | 'setup' required
route_iconstring required
route_label_keystring required
route_paramsobject
scoreinteger required
site_idstring uuid required
status'new' | 'saved' | 'done' | 'dismissed' required
summary_keystring required
title_keystring required
type_keystring required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.