Edit a sample

patch

https://api.confidentcannabis.com/v0/labs/sample/{sample_id}

Update one or more fields on a sample. Only the fields you send are changed.

Samples can only be edited while their order is in the 'placed' or 'in progress' status; editing a sample on an order in any other status returns the invalid_order_status error. A sample belonging to another lab returns 404 rather than 403.

The IDs for type_id, production_method_id and classification_id are the same ones used when creating a sample, and are listed at GET /sampletypes, GET /sampleproductionmethods and GET /sampleclassifications. The new sample type must belong to the same industry as the sample and its order.

The regulator sample ID cannot be edited through this API, because regulator requirements for changing it differ from state to state.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sample_id

string

required

Form Data

name

string

Display name for the sample.

strain_name

string

Strain the sample came from.

type_id

integer

Sample type ID, from GET /sampletypes.

production_method_id

integer

Production method ID, from GET /sampleproductionmethods.

classification_id

integer

Classification ID, from GET /sampleclassifications.

production_date

date

Date the sample was harvested or produced.

manifest_id

string

Manifest ID in the state's seed-to-sale system.

batch_id

string

Batch ID from the client's inventory system.

batch_size

number

Size of the batch the sample came from.

batch_size_unit

string

Unit for batch_size: units, lb or g.

lot_id

string

Lot ID from the client's inventory system.

lot_size

number

Size of the lot the sample came from.

lot_size_unit

string

Unit for lot_size: units, lb or g.

production_run_id

string

Production run ID from the client's system.

production_run_size

number

Size of the production run.

production_run_size_unit

string

Unit for production_run_size: units, lb or g.

units_per_serving

number

Serving size, in units.

servings_per_container

number

Number of servings in one container.

unit_description

string

What one unit means for this sample.

container_description

string

What one container means for this sample.

regulator_batch_id

string

Batch ID in the state's seed-to-sale tracking system.

regulator_sample_id2

string

(for Leaf) Pre-transfer batch ID.

regulator_batch_id2

string

(for Leaf) Pre-transfer inventory or lot ID.

regulator_lot_id

string

Lot ID in the state's seed-to-sale tracking system.

harvest_id

string

Harvest lot ID in the state's seed-to-sale tracking system.

notes

string

Free-text notes about the sample.

lims_id

string

Sample ID in the lab's own LIMS.

date_samples_collected

date

Date the sample was collected.

custom_field

string

Lab-defined custom field.

extra_field_1

string

extra_field_2

string

extra_field_3

string

extra_field_4

string

extra_field_5

string

extra_field_6

string

extra_field_7

string

extra_field_8

string

extra_field_9

string

extra_field_10

string

extra_date_field_1

date

extra_date_field_2

date

extra_date_field_3

date

extra_date_field_4

date

extra_date_field_5

date

extra_bool_field_1

boolean

extra_bool_field_2

boolean

extra_bool_field_3

boolean

extra_bool_field_4

boolean

extra_bool_field_5

boolean

external_data

string

Arbitrary JSON stored alongside the sample.

due_date

date

Date the results are due back to the client.

Headers

X-ConfidentCannabis-Signature

string

HMAC-SHA256 request signature. Required only when request signing is enabled for your API key — see the Request Signing guide.

X-ConfidentCannabis-Timestamp

string

Unix timestamp (seconds) of the request, required only when request signing is enabled for your API key. Requests older than 30 seconds are rejected.

Responses

200Success

400The request was malformed or failed validation. Validation failures include per-field messages in error_details. Possible error_code values: invalid_request, request_too_old.

401Authentication failed. Possible error_code values: missing_api_key, invalid_api_key, invalid_credentials_type, api_access_restricted, api_access_denied, missing_signature, missing_timestamp, invalid_timestamp, invalid_signature.

403The API key is valid but does not have permission for this endpoint (for example, a client key calling a labs endpoint). Possible error_code values: permission_denied.

404The requested record does not exist or is not visible to this organization. Possible error_code values: not_found.