POST api/Mailbox/FolderPost
Request Information
URI Parameters
None.
Body Parameters
MailFolderViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| IsPublicFolder | boolean |
None. |
|
| Unread | integer |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| ParentID | integer |
None. |
|
| IsVisible | boolean |
None. |
|
| ParentName | string |
None. |
|
| CompanyID | integer |
None. |
|
| Language | string |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedUserID | globally unique identifier |
None. |
|
| ModifiedDate | date |
None. |
|
| ModifiedUserID | globally unique identifier |
None. |
|
| FeatureID | globally unique identifier |
None. |
|
| Token | globally unique identifier |
None. |
|
| Action | Actions |
None. |
|
| FilterText | string |
None. |
|
| CurrentIndex | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalRecords | integer |
None. |
|
| SortColumn | string |
None. |
|
| Sortby | SortDirection |
None. |
|
| ImageId | integer |
None. |
|
| IsDeleted | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| Sort | integer |
None. |
|
| Messages | Collection of ErrorMessage |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"IsPublicFolder": true,
"Unread": 3,
"Name": "sample string 4",
"Description": "sample string 5",
"ParentID": 1,
"IsVisible": true,
"ParentName": "sample string 7",
"CompanyID": 8,
"Language": "sample string 9",
"CreatedDate": "2026-03-22T12:00:04.7285916+00:00",
"CreatedUserID": "e9324f2c-3600-409c-a84a-352d27a1366a",
"ModifiedDate": "2026-03-22T12:00:04.7285916+00:00",
"ModifiedUserID": "cf30bbb1-f71d-49b0-b7cf-af0905357408",
"FeatureID": "f44d8fc4-0fde-4e6c-a239-66de5db3f81c",
"Token": "e83ab73f-e3c4-4ba1-871b-97d4f99b107f",
"Action": 0,
"FilterText": "sample string 16",
"CurrentIndex": 17,
"PageSize": 18,
"TotalRecords": 19,
"SortColumn": "sample string 20",
"Sortby": 0,
"ImageId": 1,
"IsDeleted": true,
"IsActive": true,
"Sort": 1,
"Messages": [
{
"ErrorType": 1,
"Message": "sample string 2"
},
{
"ErrorType": 1,
"Message": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<MailFolderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core.NotificationModels">
<Action xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">View</Action>
<CompanyID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">8</CompanyID>
<CreatedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-03-22T12:00:04.7285916+00:00</CreatedDate>
<CreatedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">e9324f2c-3600-409c-a84a-352d27a1366a</CreatedUserID>
<CurrentIndex xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">17</CurrentIndex>
<FeatureID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">f44d8fc4-0fde-4e6c-a239-66de5db3f81c</FeatureID>
<FilterText xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 16</FilterText>
<ImageId xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</ImageId>
<IsActive xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsActive>
<IsDeleted xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsDeleted>
<Language xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 9</Language>
<Messages xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">
<ErrorMessage>
<ErrorType>1</ErrorType>
<Message>sample string 2</Message>
</ErrorMessage>
<ErrorMessage>
<ErrorType>1</ErrorType>
<Message>sample string 2</Message>
</ErrorMessage>
</Messages>
<ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-03-22T12:00:04.7285916+00:00</ModifiedDate>
<ModifiedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">cf30bbb1-f71d-49b0-b7cf-af0905357408</ModifiedUserID>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">18</PageSize>
<Sort xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</Sort>
<SortColumn xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 20</SortColumn>
<Sortby xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">Asc</Sortby>
<Token xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">e83ab73f-e3c4-4ba1-871b-97d4f99b107f</Token>
<TotalRecords xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">19</TotalRecords>
<Description>sample string 5</Description>
<ID>1</ID>
<IsPublicFolder>true</IsPublicFolder>
<IsVisible>true</IsVisible>
<Name>sample string 4</Name>
<ParentID>1</ParentID>
<ParentName>sample string 7</ParentName>
<Unread>3</Unread>
</MailFolderViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.