Delete free access document

The Delete free access document method is used to delete a reseller's document that can be accessed without the manager's token.

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}/free_access_documents/{free_access_document_id}

Arguments

Name

Parameter Type

Data type

Required/Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a manager that performs the operation (see Viewing and updating manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathnumberRequiredID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information)

free_access_document_id

pathnumberRequiredDocument ID

Response model

Name

Data type

Description

dataobjectResponse data


id

string

Document ID in the platform

typestringData type

attributesobjectDocument information


created_at

string

Date and time of the document creation


updated_at

string

Data and time of the document last update


namestringDocument name

Request example

DELETE /api/v3/resellers/1/free_access_documents/56
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "data": {
        "id": "56",
        "type": "free_access_documents",
        "attributes": {
            "created_at": "2020-10-09T16:49:19.699819+0300",
            "updated_at": "2020-10-09T17:02:40.984184+0300",
            "name": "1.pdf"
        }
    }
}