Update a notebook entry's metadata

PATCH

https://{tenant_name}.benchling.com/api/v2/entries/:entry_id

PATCH

/api/v2/entries/:entry_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/entries/entry_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "apiURL": "https://benchling.com/api/v2/entries/etr_tv7m7B78",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "assignedReviewers": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "days": [
    {
      "date": "string",
      "notes": [
        {
          "type": "text",
          "indentation": 0,
          "links": [
            {
              "id": "string",
              "type": "link",
              "webURL": "string"
            }
          ],
          "text": "string"
        }
      ],
      "title": "string"
    }
  ],
  "displayId": "string",
  "entryTemplateId": "string",
  "fields": {},
  "folderId": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string",
  "reviewRecord": {
    "comment": "string",
    "reviewChanges": [
      {
        "action": "SEND_FOR_REVIEW",
        "comment": "string",
        "createdAt": "2024-01-15T09:30:00Z",
        "esigned": true,
        "id": "string",
        "reviewSnapshot": {
          "createdAt": "2024-01-15T09:30:00Z",
          "downloadURL": "string",
          "expiresAt": "2024-01-15T09:30:00Z",
          "size": 1,
          "status": "PENDING"
        }
      }
    ],
    "reviewProcesses": [
      {
        "completionStatus": "APPROVED",
        "id": "string",
        "name": "string",
        "stages": [
          {
            "actionLabel": "APPROVE",
            "id": "string",
            "name": "string",
            "reviewers": [
              {
                "handle": "string",
                "id": "string",
                "name": "string",
                "status": "BLOCKED"
              }
            ]
          }
        ],
        "type": "SELF_REVIEW"
      }
    ],
    "status": "ACCEPTED"
  },
  "schema": {
    "id": "string",
    "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
    "name": "string"
  },
  "webURL": "string"
}

Update a notebook entry's metadata

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entry_idstringRequired

ID of the entry

Query parameters

returningstringOptional

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

This endpoint expects an object.

authorIdsstringOptional

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

fieldsmap from strings to objectsOptional

Schema fields to set on the entry

folderIdstringOptional

ID of the folder that will contain the entry

namestringOptional

New name of the entry

schemaIdstringOptional

ID of the schema for the entry

Response

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Entry in the API.

archiveRecordobject or nullOptional

ArchiveRecord Resource if the entry is archived. This is null if the entry is not archived.

assignedReviewerslist of objectsOptional

Array of users assigned to review the entry, if any.

authorslist of objectsOptional

Array of UserSummary Resources of the authors of the entry. This defaults to the creator but can be manually changed.

createdAtdatetimeOptionalRead-only

DateTime the entry was created at

creatorobjectOptional

UserSummary Resource of the user who created the entry

customFieldsmap from strings to objectsOptional

dayslist of objectsOptional

Array of day objects. Each day object has a date field (string) and notes field (array of notes, expand further for details on note types).

displayIdstringOptional

User-friendly ID of the entry

entryTemplateIdstring or nullOptional

ID of the Entry Template this Entry was created from

fieldsmap from strings to objectsOptional

folderIdstringOptional

ID of the folder that contains the entry

idstringOptional

ID of the entry

modifiedAtstringOptional

DateTime the entry was last modified

namestringOptional

Title of the entry

reviewRecordobject or nullOptional

Review record if set

schemaobject or nullOptional

Entry schema if set

webURLstringOptional

URL of the entry