API - Delete translated content directory

This method lets you delete all files in a sub-directory of the IN, OUT or Sandbox directories. This is useful if you group files inside sub-directories. For example, a source file "myfolder1\myfile.docx" is located inside folder "myfolder1".

URL

(DELETE) /api/files/directory?token=&locale=&folder=&directoryname=

Please note that this is an HTTP DELETE action.

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

locale

Either the source language code, a target language code or "sandbox" to delete sandbox files (used to obtain cost quotations).

Language codes are ISO 2 letter codes such as “en”, “fr”, “en-GB”, “en-US”, etc.

directoryname

The relative path of the sub-directory.

  • This can be a folder like “myfolder1”.
  • Or, it can include further directories such as “myfolder1\folder2”.

Do not use absolute paths - these are not allowed.

RESULTS

The method returns no result. An HTTP status of 204 indicates success.

If the directory does not exist, the method returns HTTP 400.

See HTTP status values for error handling.





Copyright Wordbee - Buzzin' Outside the Box since 2008