Delete note
The Delete note method is used to delete a note added to an entity in the platform.
The method is not available to managers with the Product owner role (see Get manager).
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating Manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
DELETE {base_url}/api/v3/resellers/{reseller_id}/notes/{note_id}Arguments
Name | Parameter Type | Data type | Required/Optional | Description |
|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating Manager's information) |
| Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json |
| Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json |
| base_url | path | string | Required | ActivePlatform URL |
| reseller_id | path | integer | Required | ID of the current reseller or any of its downstream resellers (see Viewing and updating Reseller general information) |
note_id | path | integer | Required | Note ID |
Response model
The method returns an empty response with the code 204 No content.
Request example
DELETE /api/v3/resellers/1/notes/56
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json