Create a new contacts folder.
The new contacts folder containing the name and optionally the parent contact folder id.
Name | Description | Type | Additional information |
---|---|---|---|
Name
The name of the folder.
Type
string
Additional info
Required, Max length: 50
|
|||
Name |
The name of the folder. |
string |
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
|
|||
ParentFolderId |
The id of the parentFolder. If you want to create a root folder, you can omit this property. |
integer |
Range: inclusive between 0 and 32767 |
{ "Name": "Lorem Ipsum", "ParentFolderId": 1 }
<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>
Payload containing the id of the created contact folder.
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data |
The actual data returned by the request. |
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. |
Hateoas |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-12-12T20:22:24.5873875Z", "IsFiltered": true }, "Data": { "ContactFolderId": 1, "Succeeded": true, "FailureMessage": "sample string 3" } }
<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-12-12T20:22:24.5873875+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>