Prompts
Update a prompt
Replaces the text of a prompt and its active state. Both prompt and is_active must be sent on every call. You may also pass monitor_id to move the prompt to another monitor in the same project, or tags to replace the prompt's tag set.
/api/v1/prompts/{prompt}
Sometimes you may wish to move a prompt to a different monitor. You may pass the new monitor's id via monitor_id; the monitor must belong to the active project. The prompt's collected responses move with it, so keep in mind that they were gathered under the previous monitor's country, language, and platform settings.
The tags field replaces the prompt's full tag set rather than appending to it. Of course, if you would like to add or remove a single tag without restating the rest, you may reach for the dedicated attach and detach endpoints instead.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| prompt | integer | Required | The numeric ID of the prompt. |
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| prompt | string | Required | The new text of the question. May be up to 2000 characters. |
| is_active | boolean | Required | When set to |
| monitor_id | integer | Optional | The id of the monitor the prompt should run under. The monitor must belong to the active project. When omitted, the prompt keeps its current monitor. Responses collected so far move with the prompt. |
| tags | integer[] | Optional | Tag ids that replace the prompt's full tag set. Each tag must belong to the active project. When omitted, the prompt's tags are left unchanged. |
Response
The prompt object
| Field | Type | Description |
|---|---|---|
| id | integer | The unique ID of the prompt. |
| monitor_id | integer | The ID of the monitor that owns this prompt. |
| prompt | string | The question text the monitor asks each engine on every run. |
| is_active | boolean | Whether the prompt will run on each daily run of its monitor. |
| created_at | datetime | When the prompt was created. |
| updated_at | datetime | When the prompt was last updated. |