Content

Set an item’s icon

Set a folder’s or an item’s icon, its colour, or both.

post/v1/content/items/{id}/icon

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/content/items/{id}/icon
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Item or folder ID, from the tree

Headers

Idempotency-Keystring

Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 IDEMPOTENCY_KEY_REUSED. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

Request body

iconstring nullable

An icon name; null clears it

colorstring nullable

A colour name (teal, teal-500) or #rrggbb; null clears it

expectedVersioninteger required

The version you read; a change since answers 409 CONTENT_VERSION_CONFLICT

Response

The item

successtrue required

Changes

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