Update Alert

put

https://api.doppel.com/v1/alert

Updates an alert's information in Doppel's system. Works across all modules.

You must provide exactly one of id or entity to identify the alert. At least one field to update must be provided in the request body.

Paired parameters:

tag_action and tag_name must both be provided together.
file_action and files must both be provided together.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

x-organization-code

string

(optional) Your Doppel Organization Code. Required if user is in multiple organizations.

Query Params

string

The alert ID (format ORG-1234). Mutually exclusive with entity.

entity

string

The URL, phone number, or email of the alert to update. Mutually exclusive with id.

Body Params

Fields to update on the alert. At least one field is required.
tag_action/tag_name and file_action/files are paired — both in each pair must be provided together.

queue_state

string

enum

New queue state to update the alert with.
(Note: taken_down is equivalent to Resolved in the Doppel Vision App)

Allowed:

entity_state

string

enum

The live status of the entity (URL, phone number, etc.) that the alert is tracking.

active: The entity is currently live/accessible.
down: The entity is no longer accessible (e.g. domain taken down).
parked: The domain is parked (registered but not hosting active content).
suspicious: The entity appears to be malicious or suspicious.
unclassified: The entity has not yet been classified.
unrelated: The entity has been determined to be unrelated to the brand.
related: The entity is related to the brand but not necessarily malicious.
unknown: The entity's status cannot be determined.

comment

string

A new comment to add to the alert.

tag_action

string

enum

Action to take on a tag for an alert.

add: Associate the named tag with the alert.
remove: Remove the named tag from the alert.

Allowed:

tag_name

string

Name of the tag to add or remove. Must be provided together with tag_action.

file_action

string

enum

Type of file operation to perform on an alert.

upload: Upload new files (file_to_upload is required for each file).
delete: Delete existing files (only file_name is required).

Allowed:

files

array of objects

length ≤ 10

List of files to upload or delete. Must be provided together with file_action. Maximum 10 files per request. When file_action is "upload", each file must include base64-encoded content in file_to_upload. When file_action is "delete", only file_name is required.
For Telco alerts, uploaded image files may also be used as the alert's canonical screenshot. If an uploaded Telco image is selected as the screenshot, Doppel stores a separate screenshot copy for alert review and downstream enforcement workflows while preserving the original Uploaded Files copy. Deleting the uploaded-file copy does not delete the canonical screenshot copy.

files

Responses

200Updated alert successfully

400Invalid input

401Unauthorized

404Alert or tag not found

429Rate limit exceeded

500Internal Server Error