Skip to main content

/files/{id}/close (PATCH)

Close a specific file, based on the Cargosnap ID with the /files/id/close route. This works well if you know/have the specific id that refers to the Cargosnap file. If you do not have the Cargosnap reference, but your own, use the /Files route to query the data and/or the ID.

Parameters​

the /files/id/close endpoint takes no further parameters.

id (int)

Unique ID of the Cargosnap file.

Response values​

N/A

Example Request​

PATCH https://api.cargosnap.com/api/v2/files/1234/close

This query would:

  • close a single file, or none (if not authorized/found/deleted etc.)
  • Return details of closed file