Reports

Update report

Updates an owned personal report or an authorized team report and recalculates its next UTC run.

patch/api/reports/{report_id}

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/reports/{report_id}
  • Auth: API key in cookie hk_token

Path parameters

report_idstring uuid required

Report definition UUID.

Request body

external_recipient_emailsstring[]
namestring
preset'site_summary' | 'portfolio_digest' | 'opportunity_brief'
recipient_user_idsstring[]
site_idsstring[]
site_mode'selected' | 'all_accessible'
status'draft' | 'active' | 'paused'

Response

Updated report

consent_versioninteger
created_atstring date-time required
created_bystring uuid
idstring uuid required
last_outcomeobject
namestring required
next_run_atstring date-time
owner_user_idstring uuid
preset'site_summary' | 'portfolio_digest' | 'opportunity_brief' required
scope'personal' | 'team' required
site_mode'selected' | 'all_accessible' required
status'draft' | 'active' | 'paused' required
tenant_idstring uuid
updated_atstring date-time required

Changes

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