Trackers

Update the configuration of a tracker

Takes the same fields as the creation, all optional: only the fields you send change, and a sent list replaces the previous one entirely. Keywords, analysts and the title apply in place. Changing the prompts, engines, frequency or resolution of a version that HAS measured creates a new version: the score series continues across versions, and the response carries the new tracker with its new id, next to version_created. A version that has not measured yet is amended in place and keeps its id, so version_created is false.

A paused tracker takes all of it, the collection settings included. The call writes the configuration and nothing else: no survey runs, no credit is reserved, the tracker stays paused with its pause_reason, and what you set takes effect at the next POST /trackers/{id}/start. A version created this way is born paused as well. Manager or above.

patch/trackers/{id}

Request

  • Base URL: https://api.epovest.com/v1
  • URL: https://api.epovest.com/v1/trackers/{id}
  • Auth: HTTP bearer

Request body

titlestring required

Display name.

promptsstring[] required

The questions asked to the engines at every survey, phrased as a customer would ask them.

enginesEngine[] required
frequency'monthly' | 'weekly' | 'daily' | 'on_demand' required

The pace of the surveys. on_demand puts the tracker on no schedule: starting it runs one survey, and every survey after that comes from POST /trackers/{id}/survey.

resolution'hd' | 'full_hd' | '4k' | '8k' required

Repetitions of every question per engine and survey: hd=1, full_hd=3, 4k=6, 8k=9.

analystsAnalystType[]
custom_promptstring

The instruction of the custom_prompt analyst; it comes with it.

discoveryboolean

Suggests new keywords spotted in the answers. It works from keywords, so send keywords[] alongside, and check discovery in the answer.

notify_on_surveyboolean
next_survey_atstring

When the first survey runs, ISO 8601 with a date AND a time (2026-08-01T09:00), strictly in the future, read as UTC without an offset. Omitted, the first survey runs at start. Sent on a PAUSED tracker it is kept and read back like anywhere else, and it is what makes the next start wait instead of surveying right away. It goes with a frequency that has a pace: sent alongside on_demand it answers 422, and POST /trackers/{id}/survey is the move it was reaching for.

project_idstring

The UUID of a project of the account, or default for none. Omitted, the tracker files under Default.

Response

The tracker as it now stands, and whether a version was created.

version_createdboolean required

True when the edit recorded a new tracker version, which carries a new id.

Changes

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