Archive a File | COS Files API

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing & CRM

Required Scope:

Archive an existing file from a particular HubSpot account.

Archiving will not hard delete a file from a portal, but will remove that file from the HubSpot user interface.

Payload of JSON request must be populated with "{ }" to POST correctly.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.
file_id	Used in the request URL	Unique identifier for a particular file.

Example URL: http://api.hubapi.com/filemanager/api/v2/files/48373224/archive

JSON

Example POST URL: https://api.hubapi.com/filemanager/api/v2/files/file_id/archive Example POST body: {} Example Response: { "id": 7617645898, "portal_id": 62515, "name": "Screen Shot 2019-01-29 at 11.05.30 AM", "size": 413559, "height": 688, "width": 1134, "encoding": "png", "type": "IMG", "extension": "png", "cloud_key": "hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png", "s3_url": "http://cdn1.hubspot.com/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png", "friendly_url": "https://cdn2.hubspot.net/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png", "alt_key": "hubfs/62515/my%20folder/screen%20shot%202019-01-29%20at%2011.05.30%20am", "alt_key_hash": "adc05f7ba15ff6d05a625977b536a549", "title": "Screen Shot 2019-01-29 at 11.05.30 AM", "meta": { "thumbs": { "thumb": { "cloud_key": "hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/thumb.png", "friendly_url": "https://cdn2.hubspot.net/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/thumb.png", "image_name": "Screen Shot 2019-01-29 at 11.05.30 AM.png", "s3_url": "http://cdn1.hubspot.com/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/thumb.png" }, "icon": { "cloud_key": "hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/icon.png", "friendly_url": "https://cdn2.hubspot.net/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/icon.png", "image_name": "Screen Shot 2019-01-29 at 11.05.30 AM.png", "s3_url": "http://cdn1.hubspot.com/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/icon.png" }, "medium": { "cloud_key": "hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/medium.png", "friendly_url": "https://cdn2.hubspot.net/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/medium.png", "image_name": "Screen Shot 2019-01-29 at 11.05.30 AM.png", "s3_url": "http://cdn1.hubspot.com/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png/medium.png" } }, "url_scheme": "SIMPLIFIED", "allows_anonymous_access": true }, "created": 1550246674887, "updated": 1550246828004, "deleted_at": 0, "folder_id": 7355694150, "hidden": false, "cloud_key_hash": "afc1d00aa2efc3e8649ba6077b4e913e", "archived": true, "created_by": 1230836, "deleted_by": null, "replaceable": true, "url": "https://cdn2.hubspot.net/hubfs/62515/my%20folder/Screen%20Shot%202019-01-29%20at%2011.05.30%20AM.png", "alt_url": "http://cdn2.hubspot.net/hubfs/62515/my%20folder/screen%20shot%202019-01-29%20at%2011.05.30%20am.png", "cdn_purge_embargo_time": null, "file_hash": "d0b08bda871f0937069459364464ca5f" }