Delete Organizational Unit

Delete the specified organizational unit.

Path Parameters

• id string required

  Delete the organizational unit with the specified ID.

Query Parameters

• embed string

  Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

  Embeddable Link	Description
  read-task	Embeds the associated task in the response. For example, ?embed=read-task

  For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Responses

• 202
• default

---

Accepted

application/api.clumio.organizational-units=v2+json

• Schema
• Example (from schema)

---

Schema

• _embedded object

  Embedded responses related to the resource.

  read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.

  Embeds the associated task of a resource in the response if requested using the embed query parameter.

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

  read-task object

  A resource-specific HATEOAS link.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

• task_id string

  The Clumio-assigned ID of the task associated with this organizational unit. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "read-task": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "task_id": "string"
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• errors object[]

  A list of errors encountered during runtime.

  error_code uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

DELETE /organizational-units/:id    

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

id — path required

embed — query

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X DELETE 'https://us-west-2.api.clumio.com/organizational-units/:id' \
-H 'Accept: application/api.clumio.organizational-units=v2+json' \
-H 'Authorization: Bearer <TOKEN>'