In general, samples should be considered an immutable resource, but how they are shared may be updated by changing their visibility and project properties and the tags associated with them may also be changed. All other sample attributes are read-only, and the associated metadata record should be used for storing additional (mutable) structured information about a sample.
Additional authorization checks: Note that PATCHing to update the sample’s visibility triggers additional account- and organization-level checks. For certain accounts (e.g., those in which PII is deposited), it may not be possible to make samples shared or public. Please contact us to discuss setting additional restrictions on sample-sharing for your or your organization’s account. Similarly, users may only add their samples to projects for which they have appropriate project-level permissions.
Authorizations
X-API-Key
string
header
required
Path Parameters
id
string
required
Body
application/json
project
Project · object
Project
projects
Show child attributes
tags
object
Tags · object[]
InlineTag · object[]
Show child attributes
visibility
enum<string>
default:private
Enum for the v1 API visibility attribute.
Note: this is legacy and only exists for backwards-compatibility in the public v1 API.
Available options:
public,
shared,
private,
importing,
awaiting data
Response
200 - application/json
OK
$uri
string
required
read-only
Pattern: ^/api/v1/samples/[a-f0-9]{16}$
Example:
"/api/v1/samples/0d77065796f8d173"
created_at
string<date-time>
required
Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.
metadata
metadata · object
required
A metadata object.
Show child attributes
owner
users · object
required
The owner of the sample.
Show child attributes
primary_classification
classifications · object | null
required
A reference to a Classification for the sample. This will typically be the One Codex Database or Targeted Loci Database results as appropriate. Note that samples will not have a primary_classification while they are still importing or being uploaded.
Show child attributes
status
enum<string>
required
Enum for user-facing data status.
This is a subset of DataStatus for the status attribute in the APIs.
Available options:
awaiting_data,
importing,
validating,
failed_validation,
available,
deleted
visibility
enum<string>
required
Enum for the v1 API visibility attribute.
Note: this is legacy and only exists for backwards-compatibility in the public v1 API.
Available options:
public,
shared,
private,
importing,
awaiting data
error_msg
string | null
An error message if the sample failed to upload, import, or validate.
filename
string | null
The sample filename.
project
projects · object
The project the sample belongs to (optional).
projects
Project
Show child attributes
size
integer | null
The size of the uploaded file in bytes.
tags
tags · object[]
An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.
Show child attributes
updated_at
string<date-time> | null
Timestamp for when the object was last updated on the One Codex platform, encoded as a RFC 3339 timestamp.
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"One Codex Developer Docs","description":"Documentation for the One Codex API and Python SDK. One Codex is a fast, easy-to-use platform for microbiome sequencing and analysis.","colors":{"primary":"#179B9A","light":"#6BC7B7","dark":"#179B9A"},"logo":{"light":"https://mintcdn.com/onecodex/DiToQ9fYtYBO3lRU/images/onecodex-logo-inverse@2x.png?fit=max\u0026auto=format\u0026n=DiToQ9fYtYBO3lRU\u0026q=85\u0026s=5cd285bf3bec7809faf0d8cd8274bb38","dark":"https://mintcdn.com/onecodex/DiToQ9fYtYBO3lRU/images/onecodex-logo@2x.png?fit=max\u0026auto=format\u0026n=DiToQ9fYtYBO3lRU\u0026q=85\u0026s=61398ceaeb352dc656dd2bdfecd053ff"},"favicon":"https://mintcdn.com/onecodex/DiToQ9fYtYBO3lRU/ocx_favicon-64.png?fit=max\u0026auto=format\u0026n=DiToQ9fYtYBO3lRU\u0026q=85\u0026s=697811a0b3a57d419f2e697f4c6e1da3","navbar":{"links":[{"href":"mailto:support@onecodex.com","label":"Support"},{"href":"https://onecodex.github.io/onecodex/","label":"Python SDK"}],"primary":{"type":"button","label":"Platform","href":"https://app.onecodex.com"}},"footer":{"socials":{"x":"https://x.com/onecodex","bluesky":"https://bsky.app/profile/onecodex.bsky.social","github":"https://github.com/onecodex","linkedin":"https://linkedin.com/company/onecodex"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onecodex","hasAudioNarration":false,"actualSubdomain":"onecodex","customDomains":["developer.onecodex.com"],"gitSource":{"type":"github","owner":"onecodex","repo":"mainline","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada70f7059de5a640576a22","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"API Docs","count":103},{"language":"default","tag":"Analyses","count":30},{"language":"default","tag":"Workflows","count":19},{"language":"default","tag":"Documents","count":11},{"language":"default","tag":"Projects","count":11},{"language":"default","tag":"Samples","count":11},{"language":"default","tag":"API Basics","count":8},{"language":"default","tag":"Metadata \u0026 Tags","count":8},{"language":"default","tag":"Webhooks \u0026 Events","count":7},{"language":"default","tag":"Jobs","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/sample-resource-patch","slug":"/api-reference/sample-resource-patch","pageMetadata":{"title":"Updating Samples","openapi":"Patch /api/v1/samples/{id}","description":null,"href":"/api-reference/sample-resource-patch"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`In general, samples should be considered an immutable resource, but how they are shared may be updated by changing their `,_jsx(_components.code,{children:`visibility`}),` and `,_jsx(_components.code,{children:`project`}),` properties and the tags associated with them may also be changed. All other sample attributes are read-only, and the associated metadata record should be used for storing additional (mutable) structured information about a sample.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Additional authorization checks:`}),` Note that `,_jsx(_components.code,{children:`PATCH`}),`ing to update the sample’s visibility triggers additional account- and organization-level checks. For certain accounts (e.g., those in which PII is deposited), it may not be possible to make samples `,_jsx(_components.code,{children:`shared`}),` or `,_jsx(_components.code,{children:`public`}),`. Please `,_jsx(_components.a,{href:`mailto:support@onecodex.com`,children:`contact us`}),` to discuss setting additional restrictions on sample-sharing for your or your organization’s account. Similarly, users may only add their samples to projects for which they have appropriate project-level permissions.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Updating Samples","openapi":"Patch /api/v1/samples/{id}","description":null,"href":"/api-reference/sample-resource-patch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/onecodex/38c32b33da45a451/restore-ref.js"],"openApiReferenceData":{"operation":{"operationId":"patch_samples_self","parameters":["fd64dbff-e3a2-422a-8fbf-c8606938e454"],"requestBody":"cd3e00bd-b51b-4f8a-8ded-9573fcddea3a","responses":{"200":"111e8c07-54ad-4bc5-b498-04c0dc8ba15b"},"summary":"PATCH samples","method":"patch","type":"path","servers":["9832d926-3c3d-43a8-a73e-07d1076c8b65"],"security":["11453643-25e3-4bd0-b8d6-359f20aa2808"],"path":"/api/v1/samples/{id}","baseUrlOptions":["https://app.onecodex.com"],"title":"PATCH samples","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fd64dbff-e3a2-422a-8fbf-c8606938e454":{"in":"path","name":"id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"project":{"oneOf":[{"type":"object","title":"Project","properties":{"__DOLLAR_REF__":{"example":"/api/v1/projects/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/projects/[a-f0-9]{16}$","type":"string","uniqueKey":"project.oneOf.0.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"uniqueKey":"project.oneOf.0","typeLabel":"Project · object"},{"type":"object","title":"projects","required":["$uri","owner","permissions","project_name"],"properties":{"owner":{"properties":{"__DOLLAR_REF__":{"example":"/api/v1/users/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/users/[a-f0-9]{16}$","type":"string","uniqueKey":"project.oneOf.1.owner.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"title":"users","type":"object","isRequired":true,"uniqueKey":"project.oneOf.1.owner","typeLabel":"users · object"},"permissions":{"items":{"type":"string","uniqueKey":"project.oneOf.1.permissions.items.[INDEX]","typeLabel":"string"},"title":"Permissions","type":"array","isRequired":true,"uniqueKey":"project.oneOf.1.permissions","typeLabel":"string[]"},"project_name":{"oneOf":[{"type":"string","title":"Project Name","maxLength":15,"minLength":3,"pattern":"^[a-zA-Z0-9_-]{3,15}$","isRequired":true,"uniqueKey":"project.oneOf.1.project_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Project Name","isRequired":true,"uniqueKey":"project.oneOf.1.project_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"project.oneOf.1.project_name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"project.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"project.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"project.oneOf.1.description","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","title":"External Id","example":"PRJ-2024-001","uniqueKey":"project.oneOf.1.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","example":"PRJ-2024-001","uniqueKey":"project.oneOf.1.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"project.oneOf.1.external_id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"project.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"project.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"project.oneOf.1.name","typeLabel":"string | null"},"public":{"default":false,"title":"Public","type":"boolean","uniqueKey":"project.oneOf.1.public","typeLabel":"boolean"}},"uniqueKey":"project.oneOf.1","typeLabel":"projects · object"},{"type":"null","title":"Project","uniqueKey":"project.oneOf.2","typeLabel":"null"}],"uniqueKey":"project","typeLabel":"Project · object | projects · object | null"},"tags":{"oneOf":[{"type":"array","items":{"properties":{"__DOLLAR_REF__":{"example":"/api/v1/tags/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/tags/[a-f0-9]{16}$","type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX].__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"type":"object","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Tags","default":[],"uniqueKey":"tags.oneOf.0","typeLabel":"Tags · object[]"},{"type":"array","items":{"properties":{"name":{"description":"The tag label or name. Name must be 30 characters or fewer.","maxLength":30,"title":"Name","type":"string","isRequired":true,"uniqueKey":"tags.oneOf.1.items.[INDEX].name","typeLabel":"string"}},"required":["name"],"title":"InlineTag","type":"object","uniqueKey":"tags.oneOf.1.items.[INDEX]","typeLabel":"InlineTag · object"},"title":"Tags","default":[],"uniqueKey":"tags.oneOf.1","typeLabel":"InlineTag · object[]"}],"uniqueKey":"tags","typeLabel":"Tags · object[] | InlineTag · object[]"},"visibility":{"default":"private","description":"Enum for the v1 API `visibility` attribute.\n\nNote: this is legacy and only exists for backwards-compatibility in the public v1 API.","enum":["public","shared","private","importing","awaiting data"],"title":"ApiV1Visibility","type":"string","uniqueKey":"visibility","typeLabel":"enum\u003cstring>"}},"title":"SampleUpdateSchema","type":"object","uniqueKey":"","typeLabel":"SampleUpdateSchema · object"},"examples":{"Example":{"title":"Example","value":{"project":{"__DOLLAR_REF__":"/api/v1/projects/a1b2c3d4e5f67890"},"tags":[],"visibility":"private"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"111e8c07-54ad-4bc5-b498-04c0dc8ba15b":{"content":{"application/json":{"schema":{"properties":{"$uri":{"example":"/api/v1/samples/0d77065796f8d173","pattern":"^/api/v1/samples/[a-f0-9]{16}$","readOnly":true,"title":"$Uri","type":"string","isRequired":true,"uniqueKey":"$uri","typeLabel":"string"},"created_at":{"description":"Timestamp for when the object was created on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.","format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"metadata":{"description":"A metadata object.","properties":{"__DOLLAR_REF__":{"example":"/api/v1/metadata/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/metadata/[a-f0-9]{16}$","type":"string","uniqueKey":"metadata.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"title":"metadata","type":"object","isRequired":true,"uniqueKey":"metadata","typeLabel":"metadata · object"},"owner":{"description":"The owner of the sample.","properties":{"__DOLLAR_REF__":{"example":"/api/v1/users/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/users/[a-f0-9]{16}$","type":"string","uniqueKey":"owner.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"title":"users","type":"object","isRequired":true,"uniqueKey":"owner","typeLabel":"users · object"},"primary_classification":{"oneOf":[{"type":"object","title":"classifications","description":"A reference to a Classification for the sample. This will typically be the [One Codex Database](https://docs.onecodex.com/en/articles/3761205-one-codex-database) or [Targeted Loci Database](https://docs.onecodex.com/en/articles/3754219-targeted-loci-database) results as appropriate. Note that samples will not have a `primary_classification` while they are still importing or being uploaded.","properties":{"__DOLLAR_REF__":{"example":"/api/v1/classifications/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/classifications/[a-f0-9]{16}$","type":"string","uniqueKey":"primary_classification.oneOf.0.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"primary_classification.oneOf.0","typeLabel":"classifications · object"},{"type":"null","title":"Primary Classification","description":"A reference to a Classification for the sample. This will typically be the [One Codex Database](https://docs.onecodex.com/en/articles/3761205-one-codex-database) or [Targeted Loci Database](https://docs.onecodex.com/en/articles/3754219-targeted-loci-database) results as appropriate. Note that samples will not have a `primary_classification` while they are still importing or being uploaded.","isRequired":true,"uniqueKey":"primary_classification.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"primary_classification","typeLabel":"classifications · object | null"},"status":{"description":"Enum for user-facing data status.\n\nThis is a subset of `DataStatus` for the `status` attribute in the APIs.","enum":["awaiting_data","importing","validating","failed_validation","available","deleted"],"title":"UserFacingDataStatus","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"visibility":{"description":"Enum for the v1 API `visibility` attribute.\n\nNote: this is legacy and only exists for backwards-compatibility in the public v1 API.","enum":["public","shared","private","importing","awaiting data"],"title":"ApiV1Visibility","type":"string","isRequired":true,"uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"error_msg":{"oneOf":[{"type":"string","title":"Error Msg","description":"An error message if the sample failed to upload, import, or validate.","uniqueKey":"error_msg.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error Msg","description":"An error message if the sample failed to upload, import, or validate.","uniqueKey":"error_msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_msg","typeLabel":"string | null"},"filename":{"oneOf":[{"type":"string","title":"Filename","description":"The sample filename.","uniqueKey":"filename.oneOf.0","typeLabel":"string"},{"type":"null","title":"Filename","description":"The sample filename.","uniqueKey":"filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"filename","typeLabel":"string | null"},"project":{"oneOf":[{"type":"object","title":"projects","description":"The project the sample belongs to (optional).","properties":{"__DOLLAR_REF__":{"example":"/api/v1/projects/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/projects/[a-f0-9]{16}$","type":"string","uniqueKey":"project.oneOf.0.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"uniqueKey":"project.oneOf.0","typeLabel":"projects · object"},{"type":"object","title":"Project","description":"The project the sample belongs to (optional).","properties":{"__DOLLAR_REF__":{"example":"/api/v1/projects/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/projects/[a-f0-9]{16}$","type":"string","uniqueKey":"project.oneOf.1.__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"uniqueKey":"project.oneOf.1","typeLabel":"Project · object"},{"type":"null","title":"Project","description":"The project the sample belongs to (optional).","uniqueKey":"project.oneOf.2","typeLabel":"null"}],"uniqueKey":"project","typeLabel":"projects · object | Project · object | null"},"size":{"oneOf":[{"type":"integer","title":"Size","description":"The size of the uploaded file in bytes.","uniqueKey":"size.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Size","description":"The size of the uploaded file in bytes.","uniqueKey":"size.oneOf.1","typeLabel":"null"}],"uniqueKey":"size","typeLabel":"integer | null"},"tags":{"default":[],"description":"An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.","items":{"properties":{"__DOLLAR_REF__":{"example":"/api/v1/tags/a1b2c3d4e5f67890","format":"uri","pattern":"^/api/v1/tags/[a-f0-9]{16}$","type":"string","uniqueKey":"tags.items.[INDEX].__DOLLAR_REF__","typeLabel":"string\u003curi>"}},"title":"tags","type":"object","uniqueKey":"tags.items.[INDEX]","typeLabel":"tags · object"},"title":"Tags","type":"array","uniqueKey":"tags","typeLabel":"tags · object[]"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","description":"Timestamp for when the object was last updated on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.","format":"date-time","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","description":"Timestamp for when the object was last updated on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["$uri","created_at","metadata","owner","primary_classification","status","visibility"],"title":"samples","type":"object","uniqueKey":"","typeLabel":"samples · object"},"examples":{"Example":{"title":"Example","value":{"$uri":"/api/v1/samples/0d77065796f8d173","created_at":"2023-11-07T05:31:56Z","metadata":{"__DOLLAR_REF__":"/api/v1/metadata/a1b2c3d4e5f67890"},"owner":{"__DOLLAR_REF__":"/api/v1/users/a1b2c3d4e5f67890"},"primary_classification":{"__DOLLAR_REF__":"/api/v1/classifications/a1b2c3d4e5f67890"},"status":"awaiting_data","visibility":"public","error_msg":"\u003cstring>","filename":"\u003cstring>","project":{"__DOLLAR_REF__":"/api/v1/projects/a1b2c3d4e5f67890"},"size":123,"tags":[],"updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"}},"security":{"11453643-25e3-4bd0-b8d6-359f20aa2808":{"apiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[]}}},"servers":{"9832d926-3c3d-43a8-a73e-07d1076c8b65":{"url":"https://app.onecodex.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi-mintlify.json"},"subdomain":"onecodex","siteName":"One Codex Developer Docs","title":"Updating Samples - One Codex Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T09:07:08.872Z","originalFileLocation":"api-reference/sample-resource-patch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"One Codex Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Updating Samples - One Codex Developer Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"One Codex Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.onecodex.com/api-reference/sample-resource-patch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onecodex.mintlify.site/_mintlify/api/og/v2?division=Samples\u0026amp;title=Updating+Samples\u0026amp;theme=a25c4bebe925f61a5b8ad332\u0026amp;signature=812541c30acc403948395f97f9dcf981af70dc6b280d138738f3860c67b7f850\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Updating Samples - One Codex Developer Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onecodex.mintlify.site/_mintlify/api/og/v2?division=Samples\u0026amp;title=Updating+Samples\u0026amp;theme=a25c4bebe925f61a5b8ad332\u0026amp;signature=812541c30acc403948395f97f9dcf981af70dc6b280d138738f3860c67b7f850\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/onecodex/Wn_cD8jjSYN9-4U4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"One Codex Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#179B9A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.onecodex.com/api-reference/sample-resource-patch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sample-resource-patch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.onecodex.com/#organization\",\"name\":\"One Codex Developer Docs\",\"url\":\"https://developer.onecodex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onecodex/DiToQ9fYtYBO3lRU/images/onecodex-logo-inverse@2x.png?fit=max\u0026auto=format\u0026n=DiToQ9fYtYBO3lRU\u0026q=85\u0026s=5cd285bf3bec7809faf0d8cd8274bb38\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.onecodex.com#website\",\"name\":\"One Codex Developer Docs\",\"url\":\"https://developer.onecodex.com\",\"publisher\":{\"@id\":\"https://developer.onecodex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.onecodex.com/api-reference/sample-resource-patch#webpage\",\"url\":\"https://developer.onecodex.com/api-reference/sample-resource-patch\",\"name\":\"Updating Samples\",\"dateModified\":\"2026-09-15T09:07:08.872Z\",\"isPartOf\":{\"@id\":\"https://developer.onecodex.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.onecodex.com/api-reference/sample-resource-patch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.onecodex.com/api-reference/sample-resource-patch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Samples\",\"item\":\"https://developer.onecodex.com/api-reference/sample-resource\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Updating Samples\",\"item\":\"https://developer.onecodex.com/api-reference/sample-resource-patch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.onecodex.com/api-reference/sample-resource-patch#apireference\",\"headline\":\"Updating Samples\",\"name\":\"Updating Samples\",\"url\":\"https://developer.onecodex.com/api-reference/sample-resource-patch\",\"mainEntityOfPage\":{\"@id\":\"https://developer.onecodex.com/api-reference/sample-resource-patch#webpage\"},\"dateModified\":\"2026-09-15T09:07:08.872Z\",\"publisher\":{\"@id\":\"https://developer.onecodex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.onecodex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"One Codex Developer Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"One Codex Developer Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sample-resource-patch.md","siteName":"One Codex Developer Docs","nav":{"global":null,"tabs":[{"tab":"API Docs","groups":[{"group":"API Basics","pages":[{"title":"Getting Started","href":"/api-reference/getting-started"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"API Documentation","href":"/api-reference/api-documentation"},{"title":"CLI \u0026 Client Library (Python)","href":"/api-reference/command-line-interface"},{"title":"Jupyter Notebooks","href":"/api-reference/jupyter-notebooks"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Rate Limits","href":"/api-reference/rate-limits"}]},{"group":"Samples","pages":[{"title":"The Sample Resource","href":"/api-reference/sample-resource"},{"title":"Retrieve All Samples","openapi":"GET /api/v1/samples","href":"/api-reference/sample-resource-instances"},{"title":"Retrieve A Sample","openapi":"GET /api/v1/samples/{id}","href":"/api-reference/sample-resource-get"},{"title":"Retrieve Public Samples","openapi":"GET /api/v1/samples/public","href":"/api-reference/sample-resource-instances-public"},{"group":"Uploading Samples","pages":[{"title":"Uploads Overview","href":"/api-reference/uploading-samples"},{"title":"Starting an Upload","openapi":"POST /api/v1/samples/init_upload","href":"/api-reference/sample-resource-upload-file"},{"title":"Confirming an Upload","openapi":"POST /api/v1/samples/confirm_upload","href":"/api-reference/sample-resource-confirm-upload"},{"title":"Pre-Uploading Samples","openapi":"POST /api/v1/samples/preupload","description":null,"href":"/api-reference/sample-resource-preupload"}]},{"title":"Updating Samples","openapi":"Patch /api/v1/samples/{id}","href":"/api-reference/sample-resource-patch"},{"title":"Downloading Sequence Data","openapi":"POST /api/v1/samples/{id}/download_uri","description":null,"href":"/api-reference/sample-resource-download"},{"title":"Delete A Sample","openapi":"DELETE /api/v1/samples/{id}","href":"/api-reference/sample-resource-delete"}]},{"group":"Projects","pages":[{"title":"The Project Resource","href":"/api-reference/project-resource"},{"title":"Retrieve All Projects","openapi":"GET /api/v1/projects","href":"/api-reference/project-resource-instances"},{"title":"Retrieve Public Projects","openapi":"GET /api/v1/projects/public","href":"/api-reference/project-resource-instances-public"},{"title":"Retrieve A Project","openapi":"GET /api/v1/projects/{id}","href":"/api-reference/project-resource-get"},{"title":"Create A Project","openapi":"POST /api/v1/projects","href":"/api-reference/project-resource-create"},{"title":"Update A Project","openapi":"PATCH /api/v1/projects/{id}","href":"/api-reference/project-resource-patch"},{"title":"Delete A Project","openapi":"DELETE /api/v1/projects/{id}","href":"/api-reference/project-resource-delete"},{"group":"Sharing \u0026 Members","pages":[{"title":"List Project Members","openapi":"GET /api/v1/projects/{id}/members","href":"/api-reference/project-resource-members"},{"title":"Add A User To A Project","openapi":"POST /api/v1/projects/{id}/add_user","href":"/api-reference/project-resource-add-user"},{"title":"Remove A User From A Project","openapi":"POST /api/v1/projects/{id}/remove_user","href":"/api-reference/project-resource-remove-user"},{"title":"Change Project Sharing","openapi":"POST /api/v1/projects/{id}/change_sharing","href":"/api-reference/project-resource-change-sharing"}]}]},{"group":"Metadata \u0026 Tags","pages":[{"title":"The Metadata Resource","href":"/api-reference/metadata-resource"},{"title":"The Tag Resource","href":"/api-reference/tag-resource"},{"title":"Retrieve All Metadata","openapi":"GET /api/v1/metadata","href":"/api-reference/metadata-resource-instances"},{"title":"Retrieve A Metadata Record","openapi":"GET /api/v1/metadata/{id}","href":"/api-reference/metadata-resource-get"},{"title":"Retrieve All Tags","openapi":"GET /api/v1/tags","href":"/api-reference/tag-resource-instances"},{"title":"Retrieve A Tag","openapi":"GET /api/v1/tags/{id}","href":"/api-reference/tag-resource-get"},{"title":"Create A Tag","openapi":"POST /api/v1/tags","href":"/api-reference/tag-resource-create"},{"title":"Updating Metadata","openapi":"PATCH /api/v1/metadata/{id}","href":"/api-reference/metadata-resource-patch"}]},{"group":"Analyses","pages":[{"title":"The Analysis Resource","href":"/api-reference/analysis-resource"},{"title":"Retrieve All Analyses","openapi":"GET /api/v1/analyses","href":"/api-reference/analysis-resource-instances"},{"title":"Retrieve An Analysis","openapi":"GET /api/v1/analyses/{id}","href":"/api-reference/analysis-resource-get"},{"title":"Retrieve Analysis Results","openapi":"GET /api/v1/analyses/{id}/results","href":"/api-reference/analysis-resource-results"},{"title":"Retrieve Analysis Output File Details","openapi":"GET /api/v1/analyses/{id}/file_details","href":"/api-reference/analysis-resource-file-details"},{"group":"Classifications","pages":[{"title":"The Classification Resource","href":"/api-reference/classification-resource"},{"title":"Retrieve All Classifications","openapi":"GET /api/v1/classifications","href":"/api-reference/classification-resource-instances"},{"title":"Retrieve A Classification","openapi":"GET /api/v1/classifications/{id}","href":"/api-reference/classification-resource-get"},{"title":"Retrieve Classification Results","openapi":"GET /api/v1/classifications/{id}/results","href":"/api-reference/classification-resource-results"},{"title":"Read-Level Results","openapi":"GET /api/v1/classifications/{id}/readlevel","href":"/api-reference/classification-resource-read-level"}]},{"group":"Functional Profiles","pages":[{"title":"The Functional Profile Resource","href":"/api-reference/functional-profile-resource"},{"title":"Retrieve All Functional Profiles","openapi":"GET /api/v1/functional_profiles","href":"/api-reference/functional-profile-resource-instances"},{"title":"Retrieve A Functional Profile","openapi":"GET /api/v1/functional_profiles/{id}","href":"/api-reference/functional-profile-resource-get"},{"title":"Functional Profile Results","openapi":"GET /api/v1/functional_profiles/{id}/results","href":"/api-reference/functional-profile-resource-results"},{"title":"Functional Profile Filtered Results","openapi":"GET /api/v1/functional_profiles/{id}/filtered_results","href":"/api-reference/functional-profile-resource-filtered-results"}]},{"group":"Panels","pages":[{"title":"The Panel Resource","href":"/api-reference/panel-resource"},{"title":"Retrieve All Panels","openapi":"GET /api/v1/panels","href":"/api-reference/panel-resource-instances"},{"title":"Retrieve A Panel","openapi":"GET /api/v1/panels/{id}","href":"/api-reference/panel-resource-get"},{"title":"Panel Results","openapi":"GET /api/v1/panels/{id}/results","href":"/api-reference/panel-resource-results"}]},{"group":"Alignments","pages":[{"title":"The Alignment Resource","href":"/api-reference/alignment-resource"},{"title":"Retrieve All Alignments","openapi":"GET /api/v1/alignments","href":"/api-reference/alignment-resource-instances"},{"title":"Retrieve An Alignment","openapi":"GET /api/v1/alignments/{id}","href":"/api-reference/alignment-resource-get"}]},{"group":"MLST","pages":[{"title":"The MLST Resource","href":"/api-reference/mlst-resource"},{"title":"Retrieve All MLST Results","openapi":"GET /api/v1/mlsts","href":"/api-reference/mlst-resource-instances"},{"title":"Retrieve An MLST Result","openapi":"GET /api/v1/mlsts/{id}","href":"/api-reference/mlst-resource-get"},{"title":"MLST Results","openapi":"GET /api/v1/mlsts/{id}/results","href":"/api-reference/mlst-resource-results"}]},{"group":"Workflows","pages":[{"title":"The Workflow Resource","href":"/api-reference/workflow-resource"},{"title":"Retrieve All Workflow Runs","openapi":"GET /api/v1/workflows","href":"/api-reference/workflow-resource-instances"},{"title":"Retrieve A Workflow Run","openapi":"GET /api/v1/workflows/{id}","href":"/api-reference/workflow-resource-get"},{"title":"Workflow Results","openapi":"GET /api/v1/workflows/{id}/results","href":"/api-reference/workflow-resource-results"}]}]},{"group":"Jobs","pages":[{"title":"The Job Resource","href":"/api-reference/job-resource"},{"title":"Retrieve All Jobs","openapi":"GET /api/v1/jobs","href":"/api-reference/job-resource-instances"},{"title":"Retrieve A Job","openapi":"GET /api/v1/jobs/{id}","href":"/api-reference/job-resource-get"},{"title":"Job Details","openapi":"GET /api/v1/jobs/{id}/details","href":"/api-reference/job-resource-details"},{"title":"Create A Job","openapi":"POST /api/v1/jobs","href":"/api-reference/job-resource-create"},{"title":"Update A Job","openapi":"PATCH /api/v1/jobs/{id}","href":"/api-reference/job-resource-patch"},{"title":"Run A Job","openapi":"POST /api/v1/jobs/{id}/run","href":"/api-reference/job-resource-run"}]},{"group":"Documents","pages":[{"title":"The Document Resource","href":"/api-reference/document-resource"},{"title":"Retrieve All Documents","openapi":"GET /api/v1/documents","href":"/api-reference/document-resource-instances"},{"title":"Retrieve A Document","openapi":"GET /api/v1/documents/{id}","href":"/api-reference/document-resource-get"},{"group":"Uploading Documents","pages":[{"title":"Uploading Documents Overview","href":"/api-reference/uploading-documents"},{"title":"Starting a Document Upload","openapi":"POST /api/v1/documents/init_upload","href":"/api-reference/document-resource-upload-file"},{"title":"Confirming an Upload","openapi":"POST /api/v1/documents/confirm_upload","href":"/api-reference/document-resource-confirm-upload"}]},{"title":"Downloading Documents","openapi":"POST /api/v1/documents/{id}/download_uri","href":"/api-reference/document-resource-download"},{"title":"Rename A Document","openapi":"PATCH /api/v1/documents/{id}/rename","href":"/api-reference/document-resource-rename"},{"title":"Delete A Document","openapi":"DELETE /api/v1/documents/{id}","href":"/api-reference/document-resource-delete"},{"group":"Sharing","pages":[{"title":"Share A Document With A User","openapi":"POST /api/v1/documents/{id}/add_user","href":"/api-reference/document-resource-add-user"},{"title":"Revoke A User's Document Access","openapi":"POST /api/v1/documents/{id}/remove_user","href":"/api-reference/document-resource-remove-user"}]}]},{"group":"Webhooks \u0026 Events","pages":[{"title":"Using Webhooks","href":"/api-reference/using-webhooks"},{"title":"Checking Signatures","href":"/api-reference/checking-webhook-signatures"},{"title":"The Webhook Resource","href":"/api-reference/webhook-resource"},{"title":"Retrieve All Webhooks","openapi":"GET /api/v1/webhooks","href":"/api-reference/webhook-resource-instances"},{"title":"Retrieve A Webhook","openapi":"GET /api/v1/webhooks/{id}","href":"/api-reference/webhook-resource-get"},{"title":"Retrieve All Events","openapi":"GET /api/v1/events","href":"/api-reference/event-resource-instances"},{"title":"Retrieve An Event","openapi":"GET /api/v1/events/{id}","href":"/api-reference/event-resource-get"}]},{"group":"Users \u0026 Account","pages":[{"title":"The Account Resource","href":"/api-reference/account-resource"},{"title":"Retrieve The Authenticated Account","openapi":"GET /api/v1/account","href":"/api-reference/account-resource-get"},{"title":"The User Resource","href":"/api-reference/user-resource"},{"title":"Retrieve All Users","openapi":"GET /api/v1/users","href":"/api-reference/user-resource-instances"},{"title":"Retrieve A User","openapi":"GET /api/v1/users/{id}","href":"/api-reference/user-resource-get"}]},{"group":"Sequencing","pages":[{"title":"The Sequencing Batch Resource","href":"/api-reference/sequencing-batch-resource"},{"title":"Retrieve All Sequencing Batches","openapi":"GET /api/v1/sequencing/batches","href":"/api-reference/sequencing-batch-resource-instances"},{"title":"Retrieve A Sequencing Batch","openapi":"GET /api/v1/sequencing/batches/{id}","href":"/api-reference/sequencing-batch-resource-get"},{"title":"Registering a Sequencing Batch","openapi":"POST /api/v1/sequencing/batches/register","href":"/api-reference/sequencing-batch-resource-post"},{"title":"Retrieve Samples in a Sequencing Batch","openapi":"GET /api/v1/sequencing/batches/{id}/samples","href":"/api-reference/sequencing-batch-resource-samples"}]}]},{"tab":"Workflows","pages":[{"title":"Workflows","href":"/workflows/workflows-introduction"}]}]},"basePath":"","title":"Updating Samples - One Codex Developer Docs","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","Page-CqcDm2To.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}