BEbenchling
entries

Update a notebook entry's metadata

Update a notebook entry's metadata

patch/entries/{entry_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2-beta
  • Auth
    HTTP bearer

Path parameters

entry_idstring required

ID of the entry

Query parameters

returningstring

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, click here.

Note: "days.notes" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., "days.notes.text" will return the same model as "days.notes".

Request body

authorIdsstring

IDs of users to set as the entry's authors.

customFieldsCustomFields
fieldsFields
folderIdstring

ID of the folder that will contain the entry

namestring

New name of the entry

schemaIdstring

ID of the schema for the entry

Response

OK

apiURLstring uri

The canonical url of the Entry in the API.

createdAtstring date-time

DateTime the entry was created at

customFieldsCustomFields
displayIdstring

User-friendly ID of the entry

entryTemplateIdstring nullable

ID of the Entry Template this Entry was created from

fieldsFields
folderIdstring

ID of the folder that contains the entry

idstring

ID of the entry

modifiedAtstring

DateTime the entry was last modified

namestring

Title of the entry

webURLstring

URL of the entry

Changes

No recorded changes to this operation across all 1 revision of this API.