Message Formats

post

https://app.financekey.com/OData/MessageFormats

The message format defines the structure of an electronic message that is either sent or received via an integration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

messageFormatId

string

required

length between 1 and 64

MessageFormatId is a nvarchar field with a maximum length of 64 in the MessageFormat table. This field is used as a primary key and is a unique identifier for each record in the MessageFormat table. It is used to distinguish records and ensures data integrity in the table.

description

string

required

length ≥ 1

The Description column in the MessageFormat table is an nvarchar data type field used to store descriptive text. It can hold a maximum of 4,000 characters and ensures the data entered is in the correct form.

comment

string | null

Miscellaneous notes and information for the entry or record.

integrationCategoryId

string

required

length between 1 and 64

IntegrationCategoryId is an nvarchar field with a maximum length of 64 characters in the MessageFormat table, which stores the ID of the integration category the formatted message belongs to.

className

string | null

ClassName is a nvarchar data field in the MessageFormat table which contains a string up to 256 characters in length that names the message format class.

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!