BEbenchling
Request Template

Update RequestV2Definition

Update RequestV2Definition.

patch/api/v3/request-v2-definition/{request_v2_definition_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

request_v2_definition_idstring required

ID of the RequestV2Definition.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring nullable

Description of the request template. Must not exceed 1024 characters and must not contain a null character.

namestring

Name of the request template. Must not be empty, must not exceed 255 characters, and must not contain a null character.

prefixstring

Prefix for the displayId of requests created from this template.

templateCollectionIdstring

API ID of the template collection to move this request template to.

Response

OK

archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
descriptionstring nullable

Description of the request template.

idstring
modifiedAtstring datetime nullable
namestring
prefixstring

The prefix for the displayId of tasks of this schema.

webUrlstring nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.