Skip to content

Delete Currency

Deletes a single currency by its IRI id.

Operation

OperationTypePurpose
deleteAdminSettingsCurrency(input:)MutationDelete a currency

Notes

  • The returned node is an in-memory snapshot of the just-deleted record — its scalar fields (_id, code, name, symbol) still resolve so you can confirm what was removed.
  • Select message for the success confirmation — it resolves to "Currency deleted successfully." on a successful delete. message is null on read / list / create / update; a failed delete returns a top-level errors[] entry instead.
  • Do not select the node's IRI id field on this mutation — the IRI cannot be generated for a deleted record and the field resolves with an errors[] entry. Select _id instead, as shown.
  • Use the adminSettingsCurrencies query to discover a valid id.
  • Permission: settings.currencies.delete.

Delete guards

The store cannot delete the last currency, and it cannot delete a currency that is set as a channel's base currency. Either condition is rejected before the delete runs.

All currency operations require an admin Bearer token — see Authentication.

Released under the MIT License.