Create a notebook entry

POST

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

POST

/api/v2/entries

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

{
  "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"
}

Create a notebook entry

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

folderIdstringRequired

ID of the folder that will contain the entry

namestringRequired

Name of the entry

authorIdsstring or list of stringsOptional

customFieldsmap from strings to objectsOptional

Custom fields to add to the entry

entryTemplateIdstringOptional

ID of the template to clone the entry from

fieldsmap from strings to objectsOptional

Fields to set on the entry. Must correspond with the schema's field definitions.

initialTableslist of objectsOptional

An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the API Identifiers of the tables in the given template.

If a template table has one row, the values in that row act as default values for cloned entries.
If a template table has multiple rows, there is no default value and those rows are added to the cloned entry along with the provided csv data.
If a table has default values, they will be populated in any respective undefined columns in the csv data.
If a table has no default values, undefined columns from csv data will be empty.
If no csv data is provided for a table, the table in the entry will be populated with whatever values are in the respective template table.

schemaIdstringOptional

ID of the entry's schema

Response

Created

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

Errors

400

Bad Request Error