Unassign Company from Reseller

You can unassign a company from a reseller with the specified UID.

Required Privileges

To perform this task, a user must have the Portal Administrator role assigned.

Request

To unassign a company from a reseller, send the DELETE HTTP request to the URL of the /organizations/resellers/{resellerUid}/companies resource. Additionally you must create a query string that contains UID of a company.

HTTP Request

DELETE https://<hostname>:1280/api/v3/organizations/resellers/{resellerUid}/companies?companyUid={companyUid}

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Description

resellerUid

Path

String (uuid)

Yes

Reseller UID

companyUid

Query

String (uuid)

Yes

Company UID

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Example Unassign Company from Reseller

The following request unassigns a company with UID 93edf541-7758-4e3a-9719-042171dcc544 from a reseller with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.

Request:

DELETE https://localhost:1280/api/v3/organizations/resellers/debcdb55-afbd-4772-bf99-5ea6a3249f43/companies?companyUid=93edf541-7758-4e3a-9719-042171dcc544

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.