Update Entry | Benchling Documentation

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/entry/entry_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "authorIds": [
    "ent_a0SApq3z"
  ],
  "name": "Protein Concentration Assay 2025-01-16",
  "partsMutation": {
    "operationType": "insert",
    "version": "etrver_Ax7b2kR9",
    "parts": [
      {
        "contentType": "text",
        "text": "Sample A showed elevated concentration.",
        "formats": [
          {
            "end": 8,
            "start": 0,
            "properties": [
              "BOLD"
            ]
          }
        ]
      },
      {
        "contentType": "attachment",
        "scratchFileId": "scrfile_lHftrqPCF3WZ"
      },
      {
        "contentType": "unstructured_table",
        "name": "Follow-up Measurements",
        "columnDefinitions": [
          {
            "name": "Sample"
          },
          {
            "name": "Concentration (mg/mL)"
          }
        ],
        "rows": [
          {
            "cells": [
              {
                "inputValue": {
                  "type": "text_value",
                  "value": "Sample D"
                }
              },
              {
                "inputValue": {
                  "type": "text_value",
                  "value": "1.05"
                }
              }
            ]
          }
        ]
      }
    ],
    "position": "end_of_document"
  }
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "parts": "parts",
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "applicableReviewProcesses": "applicableReviewProcesses",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "displayId": "displayId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "review": {
    "__typename": "__typename",
    "id": "id"
  },
  "reviewSource": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "sections": [
    {
      "__typename": "__typename",
      "contents": [
        {}
      ],
      "date": "date",
      "provenanceUuid": "provenanceUuid",
      "title": "title"
    }
  ],
  "selectors": [
    {
      "__typename": "__typename",
      "name": "name",
      "options": [
        "options"
      ],
      "selectorId": "selectorId"
    }
  ],
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "versionMetadata": {
    "__typename": "__typename",
    "createdAt": "createdAt",
    "versionId": "versionId"
  }
}

Update Entry.

Authentication

AuthorizationBearer

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

Path parameters

entry_idstringRequired

ID of the Entry.

Request

This endpoint expects an object.

archiveReasonstringOptional

Specifies the archive reason when the entry is archived.

archivedbooleanOptional

Specifies whether the entry is archived.

authorIdslist of stringsOptional

Specifies user or app IDs to set as entry authors. Omit to leave authors unchanged. Provide IDs to replace the current author list. Pass an empty array to clear all authors.

contentlist of objectsOptional

namestringOptional

Specifies the entry title. Omit to leave the title unchanged.

partsMutationobjectOptional

Specifies a mutation to perform on document content parts. Omit to leave document content unchanged. Rejected on protected entries.

schemaFieldsmap from strings to objectsOptional

Specifies values for fields defined by the entry schema. Keys must be field API identifiers. Values must be API identifiers or JSON values matching the field type. Exceptions are assay run and assay result link fields, which must be warehouse UUIDs. Permitted only when the entry has a schema associated with it, or schemaId is supplied in the same request. Omit to leave schema field values unchanged.

schemaIdstring or nullOptional

Specifies the ID of the entry schema to assign when the entry has no schema. Omit to leave the schema unchanged. Reassigning the schema is not supported. The schema ID can be retrieved from the entry schema listing resource.

sectionUuidstringOptionalformat: "uuid"

Specifies the UUID of the section where legacy content is inserted when using the content field. Content is appended at the end of that section. Omit to append at the end of the document.

selectorslist of objectsOptional

Specifies dropdown selectors to create, update, or delete for unstructured tables. To create or update a selector, provide a non-empty name and at least one option. In the case of updates, provide the selector ID. To delete a selector, set delete to true and provide the selector ID.

Response

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

Lists the authors of the entry. Defaults to the creator but may be edited.

creatorobject or nullOptional

Identifies who created the entry.

partsstringOptionalformat: "uri"

Lists ordered document parts that make up the document content.

schemaFieldslist of objects or nullOptional

Lists values for fields defined by the entry schema.

applicableReviewProcessesstringOptionalformat: "uri"

Lists review processes configured for the entry's project. Use the paginated list of applicable review processes for the full list including stages and version details.

archiveReasonstring or nullOptional

Specifies the archive reason when the entry is archived.

archivedbooleanOptional

Specifies whether the entry is archived.

createdAtstring or nullOptional

Specifies when the entry was created.

customFieldslist of objects or nullOptional

Lists custom field values on the entry.

displayIdstring or nullOptional

Specifies the display ID for the entry.

folderobject or nullOptional

Specifies the folder that contains the entry.

idstringOptional

Identifies the entry.

modifiedAtstring or nullOptional

Specifies when the entry was last modified.

namestring or nullOptional

Specifies the title of the entry.

reviewobject or nullOptional

Specifies the active review for the entry when one exists. Null when the entry has not been sent for review or the review was retracted.

reviewSourceobjectOptional

Specifies the project that owns the entry and determines which review processes apply.

schemaobject or nullOptional

Specifies the entry schema when one is configured.

sectionslist of objects or nullOptional

selectorslist of objectsOptional

Lists dropdown selectors available to table cells in the document.

typedSchemaobject or nullOptional

versionMetadataobjectOptional

Specifies version metadata for the current revision of the entry.

Errors

400

Entry Update Request Bad Request Error

403

Entry Update Request Forbidden Error

404

Entry Update Request Not Found Error

409

Entry Update Request Conflict Error

429

Entry Update Request Too Many Requests Error

500

Entry Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors