Delete Folder (v3)

Use this REST API to delete a custom folder within inbox.

This REST API does not support deletion of:

• inbox
• outbox
• profitinbox
• profitoutbox

Required Roles

Service Administrator

Any application role and the Migrations – Administer granular role

REST Resource

POST /interop/rest/v3/folders/delete

Request

Supported Media Types: application/json

Table 2-176 Parameters

Name	Description	Type	Required	Default
folderName	Name of the inbox folder to delete (for example, inbox/data_loads).	Payload	Yes	None

Sample URL and Payload

https://<BASE-URL>/interop/rest/v3/folders/delete

{ 
folderName": "inbox/data_loads",
 }

Response

Supported Media Types: application/json

Table 2-177 Parameters

Parameters	Description
Details	Published if there is an error with the error string
Status	See Migration Status Codes
Links	Detailed information about the link
Href	Links to the API call
Action	The HTTP call type
Rel	Possible value: self

Example Response Body

{
  "status": -1,
  "links": [
    {
      "href": "https://<BASE-URL>/interop/rest/v3/folders/delete",
      "action": "POST",
      "rel": "self",
      "data": null
    },
    {
      "href": "https://<BASE-URL>/interop/rest/v2/status/jobs/<JOB-ID>",
      "action": "GET",
      "rel": "Job Status",
      "data": null
    }
  ],
  "details": null
}

Sample cURL command

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' -d '{"folderName":"FOLDER_TO_BE_DELETED"}' 'https://<BASE-URL>/interop/rest/v3/folders/delete'