improved

[BETA] Changes to `name` and `filename` fields

The name and filename fields returned from the GET /v2-beta/files endpoint will correspond to the in-app display name and the original name of the uploaded file, respectively. This change will go live on February 8th 2024.

What’s changing?

Responses returned from /v2-beta/files endpoints include both a name and a filename field. When creating files via the Benchling API, name is a required field and is used to populate both the filename and the display name in Benchling. Currently, both fields always have an identical value corresponding to the originally uploaded file’s name.

Going forward, these fields will be be populated properly with distinct values:

  • The name field will include the display name of the file used in Benchling. name can be updated in Benchling or via the API.
  • The filename field will include the filename of the original file uploaded to Benchling. filename cannot be changed in Benchling or via the API.

When creating files in Benchling via the API, both name and filename will be required. Additionally, updating files in Benchling via the API will optionally accept name, which will update the file’s display name.

When is this happening?

This change will go live on February 8th 2024.