MessageThread

Create MessageThread

Creates a new MessageThread

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
messageThread_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

thread_Create_Date
string or null <date-time>
thread_Create_UserId
string or null <uuid>
thread_Status
string or null <= 32 characters
thread_Title
string or null <= 512 characters
thread_Type
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/message-threads
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": {
    }
}

List MessageThread

Lists all MessageThread

SecurityapiKeyAuth
Request
query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/message-threads
Request samples 
Response samples 
No sample
Get MessageThread
Gets MessageThread


SecurityapiKeyAuth 
Request 
path Parameters
MessageThread_Key
required
integer <int32> 
MessageThread Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/message-threads/{MessageThread_Key}
Request samples 
Response samples 
No sample
Update MessageThread
Updates a specific MessageThread.


SecurityapiKeyAuth 
Request 
path Parameters
MessageThread_Key
required
integer <int32> 
MessageThread Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
messageThread_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thread_Create_Date
string or null <date-time> 
 
thread_Create_UserId
string or null <uuid> 
 
thread_Status
string or null  <= 32 characters 
 
thread_Title
string or null  <= 512 characters 
 
thread_Type
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/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": {
    }
}
Delete MessageThread
Deletes an MessageThread


SecurityapiKeyAuth 
Request 
path Parameters
MessageThread_Key
required
integer <int32> 
MessageThread Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/message-threads/{MessageThread_Key}
Request samples 
Create or Update Batch MessageThread
Create or Update multiple MessageThread at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
messageThread_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thread_Create_Date
string or null <date-time> 
 
thread_Create_UserId
string or null <uuid> 
 
thread_Status
string or null  <= 32 characters 
 
thread_Title
string or null  <= 512 characters 
 
thread_Type
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


put/message-threads-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}