VBAGateway Messaging

Get VBAGateway MessageThread

Gets VBAGateway MessageThread by key

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
MessageThread_Key
required
integer <int32>

MessageThread_Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/vbagateway-message-threads/{MessageThread_Key}
Request samples 
Response samples 
No sample
Update VBAGateway MessageThread
Update VBAGateway MessageThread by key


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
MessageThread_Key
required
integer <int32> 
MessageThread_Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
messageThread_Key
required
integer <int32> 
Unique identifier for the message thread.


 
thread_Create_Date
string or null <date-time> 
Date and time when the thread was created.


 
thread_Create_UserId
string or null <uuid> 
Unique identifier (UUID) of the user who created the thread.
If null, this is considered an admin-level action or system-generated.


 
thread_Status
string or null  <= 32 characters 
Current status of the thread, limited to 32 characters.
Possible values:
  "CLOSED"  - Closed Thread
  "NEW"     - New Thread
  "NEWREC"  - Active Thread


 
thread_Title
string or null  <= 512 characters 
Title or subject line for the thread, limited to 512 characters.


 
thread_Type
string or null  <= 32 characters 
Type or category of the thread, limited to 32 characters.


 
Responses 
200
Success


401
Unauthorized


put/vbagateway-message-threads/{MessageThread_Key}
Request samples 
{
  • "messageThread_Key": 0,
  • "thread_Create_Date": "2019-08-24T14:15:22Z",
  • "thread_Create_UserId": "a53b10b9-a14a-47bb-9122-78c03aeddc05",
  • "thread_Status": "string",
  • "thread_Title": "string",
  • "thread_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Create a Message wihtin a VBAGateway MessageThread
Create a Message wihtin a VBAGateway MessageThread. This operation will insert the new message into the VBAGateway database that is paired with this VBASoftwre database.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
MessageThread_Key
required
integer <int32> 
MessageThread_Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
message_Key
integer <int32> 
The unique identifier for the message. 
On creation, set this to 0 as it will be auto-generated by the system.


 
messageThread_Key
required
integer <int32> 
The unique identifier of the message thread this message belongs to.
This value must be provided and should reference an existing message thread.


 
message_Body
string or null
The content or body of the message being created or updated.
This can be any text relevant to the message thread.


 
message_Create_Date
string or null <date-time> 
The date and time when the message was created.
This value may be null and, if not provided, the system may assign a timestamp automatically.


 
message_Create_UserId
string or null <uuid> 
The unique identifier (UUID) of the user who created the message. 
If null, it represents an Admin submission from the VBASoftware system.
If provided, it should be the UUID from the Gateway system. This information 
should be retrieved externally if needed.


 
message_Status
string or null  <= 32 characters 
The status of the message, limited to 32 characters in length.
May represent states like "READ", "UNREAD".


 
message_Type
string or null  <= 32 characters 
The type of the message, limited to 32 characters.
May represent types "HIGH" or "STANDARD"


 
Responses 
200
Success


401
Unauthorized


post/vbagateway-message-threads/{MessageThread_Key}/messages
Request samples 
{
  • "message_Key": 0,
  • "messageThread_Key": 0,
  • "message_Body": "string",
  • "message_Create_Date": "2019-08-24T14:15:22Z",
  • "message_Create_UserId": "967ca206-05d7-4c4b-8fd8-fee4ebb68ac0",
  • "message_Status": "string",
  • "message_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get a specific MessageAttachment
Retrieves a specific MessageAttachment by its MessageAttachment_Key from the VBAGateway database.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
MessageAttachment_Key
required
integer <int32> 
MessageAttachment_Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


404
Not Found


get/vbagateway-message-attachments/{MessageAttachment_Key}
Request samples 
Response samples 
No sample