TRtrustfull
Agents

Update an Agent

Changed on

Update an Agent schedule or alert configuration. The agent type and domain cannot be changed.

patch/agent/{agentId}

Request

  • Base URL
    https://api.fido.id/1.0
  • URL
    https://api.fido.id/1.0/agent/{agentId}
  • Auth
    none declared. Required headers: x-api-key

Path parameters

agentIdstring required
Example:2bb80d537b1da3e38bd30361aa855686bde0ba21c22f0ea224cf9952cfcf46a2

The Agent identifier returned when the Agent was created.

Headers

content-typestring
acceptstring
x-api-keystring required
Example:[your-api-key]

Request body

frequency'daily' | 'weekly' | 'monthly'

How often the Agent runs a Request.

start_datestring

A new first run date and time in UTC.

score_thresholdinteger

Send an alert when the result score is lower than this value.

notification_emailstring

Email address that receives Agent alerts. Send an empty string to remove it.

webhook_urlstring

Public HTTPS endpoint that receives Agent alerts. Send an empty string to remove it.

Example request

{
  "frequency": "weekly",
  "start_date": "2026-11-08 09:00:00",
  "score_threshold": 451,
  "notification_email": "alerts@example.com",
  "webhook_url": "https://example.com/agent-alerts"
}

Response

Agent updated

idstring required

Unique Agent identifier.

agent_type'merchant_risk' required

The type of the Agent.

domainstring required

The domain submitted by each scheduled Request.

frequency'daily' | 'weekly' | 'monthly' required

How often the Agent runs a Request.

status'active' | 'archived' required

Current Agent lifecycle status.

start_datestring required

The Agent start date and time in UTC.

creation_datestring required

The Agent creation date and time in UTC.

last_checkstring nullable

The last scheduled run date and time in UTC.

next_checkstring nullable

The next scheduled run date and time in UTC. Archived Agents return null.

checks_doneinteger required

Number of scheduled runs completed by the Agent.

archive_reasonstring nullable

Why the Agent was archived automatically, when applicable.

score_thresholdinteger required

An alert is sent when the result score is lower than this value.

last_scoreinteger nullable

Score returned by the most recent completed Request.

notification_emailstring email nullable

Email address that receives Agent alerts.

webhook_urlstring uri nullable

HTTPS endpoint that receives Agent alerts.

Example response

{
  "id": "2bb80d537b1da3e38bd30361aa855686bde0ba21c22f0ea224cf9952cfcf46a2",
  "agent_type": "merchant_risk",
  "domain": "example.com",
  "frequency": "daily",
  "status": "active",
  "start_date": "2026-11-01 09:00:00",
  "creation_date": "2026-10-22 11:00:00",
  "last_check": "2026-11-01 09:00:00",
  "next_check": "2026-11-02 09:00:00",
  "checks_done": 1,
  "archive_reason": "Insufficient credits.",
  "score_threshold": 451,
  "last_score": 720,
  "notification_email": "alerts@example.com",
  "webhook_url": "https://example.com/agent-alerts"
}

Changes