DELETE 3/ContactFolders/{Id}

Definition

DELETE - 3/ContactFolders/{Id}

Delete a contacts folder based on its id.

Required roles: Contacts (write)

When you delete a contacts folder, all subfolders, all contact groups and all contacts within this folder will also be deleted. This action cannot be undone.

Request information

Uri parameters

Name	Description	Type	Additional information
Id The id of the contacts folder you would like to delete. Type integer Additional info Required
Id	The id of the contacts folder you would like to delete.	integer	Required

Response information

Response body fields

RequestResult indicating if the delete was successfull.

Name	Description	Type
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. Type ManipulationResult
Data	The actual data returned by the request.	ManipulationResult
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
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

Sample:

{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-04-19T08:20:22.6508035Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2"
  }
}