Labels

patch

https://app.financekey.com/OData/Labels({key})

Defines 'Labels' that can be assigned to records. Labels are defined and assigned by Customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

labelId

string

required

length between 1 and 450

Unique Id for the label.

description

string

required

length between 1 and 256

A description of the label and the intention of the usage.

comment

string | null

Miscellaneous notes and information for the entry or record.

badgeId

string

required

length between 1 and 32

The badge to be used when displaying the label.

badgeText

string

required

length between 1 and 32

The text to be displayed on the label badge.

badgeImage

string | null

The BadgeImage field is of data type nvarchar with a maximum length of 256 characters. It is designed to store the URL or file path of an image associated with a badge. This field allows for the inclusion of international characters, facilitating the representation of badge images in diverse contexts. The length restriction ensures efficient storage while providing ample space for standard image references.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!