Update the note on an org-list entry

curl --request PUT \ --url https://app.solya.app/api/org-lists/{listType}/entries/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "note": null }'

{ "createdAt": "2026-01-10T08:00:00.000Z", "id": "entry-uuid-1", "listType": "RETURN_REASON_CODE", "metadata": { "note": "Reviewed by Alice on 2026-06-05" }, "updatedAt": "2026-06-05T10:30:00.000Z", "value": "DAMAGED" }

Authorizations

Authorization

string

header

required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Path Parameters

listType

enum<string>

required

List type: SUPPLIER_BLACKLIST | BRAND_RESTRICTION | RETURN_REASON_CODE

Available options:

SUPPLIER_BLACKLIST,

BRAND_RESTRICTION,

RETURN_REASON_CODE

string

required

Unique identifier of the org-list entry (UUID)

Minimum string length: 1

Body

application/json

note

string | null

required

New note for the entry, or null to clear the existing note

Response

Successful response

data

object

required

Show child attributes

success

enum<boolean>

required

Available options:

true

System

Catalog

Inventory & analytics

Plans

Tasks

Intelligence

Search

Data export

Other

Update the note on an org-list entry

Authorizations

Path Parameters

Body

Response