Integrations

patch/v1/integrations/{integrationRef}

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/integrations/{integrationRef}
  • Auth: API key in header x-api-key

Path parameters

integrationRefstring required

Public integration reference

Request body

priorityinteger

Integration priority

namestring

Integration name

logoUrlstring nullable

Integration logo URL

descriptionstring

Integration description

type'BLOCKCHAIN' | 'EXCHANGE' | 'BANK'

Integration type

chainIdstring nullable

Linked chain ID

exchangeRequiredCredentialsstring nullable

Required exchange credential metadata

status'ACTIVE' | 'ALPHA' | 'BETA' | 'DISABLED'

Integration status

isEvmboolean

Whether the integration is EVM-compatible

mode'API' | 'FILE_UPLOAD'

Integration mode

processorstring nullable

Integration processor key

Response

integrationRefstring required

Public integration reference

priorityinteger required

Integration display priority

namestring required

Integration name

logoUrlstring nullable required

Integration logo URL

descriptionstring required

Integration description

type'BLOCKCHAIN' | 'EXCHANGE' | 'BANK' required

Integration type

chainIdstring nullable required

Linked chain ID

exchangeRequiredCredentialsstring nullable required

Required exchange credential metadata

status'ACTIVE' | 'ALPHA' | 'BETA' | 'DISABLED' required

Integration status

isEvmboolean required

Whether the integration is EVM-compatible

mode'API' | 'FILE_UPLOAD' required

Integration mode

processorstring nullable required

Integration processor key

walletsCountinteger required

Number of wallets using the linked chain

createdAtstring date-time required

Creation timestamp (ISO 8601)

updatedAtstring date-time required

Last update timestamp (ISO 8601)

Changes

No recorded changes to this operation across all 1 revision of this API.