inbox-agents

Deregisters an inbox agent from the specified registry. (PAY access required)

Deregisters an inbox agent from the specified registry (Please note that while the command is put on-chain, the transaction is not yet finalized by the blockchain.)

post/inbox-agents/deregister

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/deregister
Auth: API key in header token

Request body

agentIdentifierstring required

The identifier of the inbox registration (asset) to be deregistered

network'Preprod' | 'Mainnet' required

The network the inbox registration was made on

smartContractAddressstring

The smart contract address of the payment contract to which the inbox registration belongs

Example request

{
  "agentIdentifier": "agentIdentifier",
  "network": "Preprod"
}

Response

Inbox agent deregistration requested

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.