1. v3
  2. ContactFolders
  3. POST - 3/contactfolders

Definition

POST - 3/ContactFolders

Create a new contacts folder.

Required roles: Contacts (write)

Request information

The new contacts folder containing the name and optionally the parent contact folder id.

Name

The name of the folder.


Type string
Additional info
Required, Max length: 50
ParentFolderId

The id of the parentFolder. If you want to create a root folder, you can omit this property.


Type integer
Additional info
Range: inclusive between 0 and 32767

Sample: 
{
  "Name": "Lorem Ipsum",
  "ParentFolderId": 1
}
Sample: 
<SimpleContactFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Name>Lorem Ipsum</Name>
  <ParentFolderId>1</ParentFolderId>
</SimpleContactFolder>

Response information

Payload containing the id of the created contact folder.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type ContactFolderManipulationResult
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-21T10:38:12.2174494Z",
    "IsFiltered": true
  },
  "Data": {
    "ContactFolderId": 1,
    "Succeeded": true,
    "FailureMessage": "sample string 3"
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CheckMarket.Common.APIModels">
    <FailureMessage>sample string 3</FailureMessage>
    <Succeeded>true</Succeeded>
    <d2p1:ContactFolderId>1</d2p1:ContactFolderId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T10:38:12.2174494+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>