Booth Wiki Booth Wiki
Pages

api/rename

Rename a batch, or rename a single file inside a batch.

URL:

Authorization:

  • Basic Authorization Header must be defined.

Formats:

  • json

HTTP Method:

  • POST

Parameters:

  • name - new batch (or file) name. Batch names are validated and lowercased; they may contain letters, digits, - and .. Invalid characters in file names are sanitized to - instead of rejected.

Response:

{"result":"Batch renamed","type":"notice","url":"https://victori.uploadbooth.com/newname"}
  • when renaming a file:
{"result":"Batch File renamed","type":"notice","url":"https://victori.uploadbooth.com/batch/newname.jpg"}
  • on failure the result is a raw message key (not yet translated):
{"result":"new_name_invalid","type":"error"}

Possible error keys: new_name_invalid, batch_not_found, batch_name_taken, file_not_found, file_name_taken.