1. v3
  2. ContactFolders
  3. PUT - 3/contactfolders/{id}

Definition

PUT - 3/ContactFolders/{Id}

Update a contacts folder name by its id.

Required roles: Contacts (write)

Request information

Id

The id of the contacts folder you would like to update


Type integer
Additional info
Required

The contacts folder object containing the new name and parent contacts 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 updated 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 SimpleContactFolder
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-21T14:17:19.4435808Z",
    "IsFiltered": true
  },
  "Data": {
    "Name": "Lorem Ipsum",
    "ParentFolderId": 1
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <Name>Lorem Ipsum</Name>
    <ParentFolderId>1</ParentFolderId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T14:17:19.4435808+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>