inbox-agents

Delete an inbox registration record. (admin access required)

Permanently deletes an inbox registration record from the database. This action is irreversible and should only be used for registrations in specific failed or completed states.

delete/inbox-agents

Request

Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
URL: ./../api/v1/inbox-agents
Auth: API key in header token

Request body

idstring cuid required

The database ID of the inbox registration record to be deleted.

Example request

{
  "id": "example_id"
}

Response

Inbox agent registration deleted successfully

status'success' required

Example response

{
  "status": "success",
  "data": {
    "error": null,
    "id": "inbox_registry_id",
    "name": "Inbox Agent",
    "description": "Masumi inbox identity registration",
    "agentSlug": "inbox-agent",
    "state": "RegistrationRequested",
    "createdAt": "1970-01-20T20:00:36.260Z",
    "updatedAt": "1970-01-20T20:00:36.260Z",
    "lastCheckedAt": null,
    "agentIdentifier": "policy_id_asset_name_policy_id_asset_name_policy_id_asset_name",
    "metadataVersion": 1,
    "sendFundingLovelace": null,
    "SmartContractWallet": {
      "walletVkey": "wallet_vkey",
      "walletAddress": "wallet_address"
    },
    "RecipientWallet": null,
    "CurrentTransaction": null
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.