Put data
Which EndPoints allow PUT in the API!
10 minute read
Attention
Only the endpoints listed below can be updated using the API and only the listed PUT fields can be updated on each endpoint. Field values are as explained for the POST API endpoints, except that in all cases you must also provide the id of the record to be updated.
Quick links
individuals (PUT)
Individuals (GET lists, POST creates, PUT updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or individual_id.) | 12 |
collector | No | Collector(s) id, abbreviation, name or email. Use | or ; to separate multiple people; first is main collector. | J.Silva|M.Costa |
dataset | No | Dataset id or acronym. | 3 or FOREST1 |
date | No | Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day. | 2024-05-20 or {\"year\":1888,\"month\":5} |
identification_based_on_biocollection | No | Biocollection name/id used as reference for identification. | INPA |
identification_based_on_biocollection_number | No | CatalogNumber in the reference biocollection | 8765 |
identification_date | No | Identification date (full or incomplete). | 2023-06-NA |
identification_individual | No | ID/organismID of another individual that provides the taxonomic identification for the individual’s record | 3245 or REC-123 |
identification_notes | No | Notes for the identification. | Checked with microscope |
identifier | No | Person(s) responsible for identification; accept id, abbreviation, name or email; separate multiple with | or ;. Required when taxon is informed. Use identifier=collector to use the collector value explicitly provided in the same record, or identifier=keep in updates to preserve the existing identifier. | Costa, A.|Lima, B. or 1|2|3 or collector or keep |
individual_id | No | Numeric ID of the record to be updated (Provide id or individual_id.) | 12 |
modifier | No | Identification modifier code/name (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5). | 3 |
notes | No | Free text or JSON notes field. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
tag | No | Individual tag/number/code. | A-1234 |
taxon | No | Taxon id or canonical full name list. | Licaria cannela or 456,789 |
individual-locations (PUT)
Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or individual_location_id.) | 12 |
altitude | No | Elevation in meters. | 75 |
angle | No | Azimuth from reference point, in degrees. | 45 |
distance | No | Distance from reference point in meters. | 12.5 |
individual | No | Individual id, uuid or organismID (fullname). | 4521 or 2ff0e884-3d33 |
individual_location_id | No | Individual-location record id. (Provide id or individual_location_id.) | 44 |
latitude | No | Latitude in decimal degrees (negative for south). | -3.101 |
location | No | Location id or name. | Parcela 25ha or 55 |
location_date_time | No | Date or date+time for the occurrence/location event. | 2023-08-14 12:30:00 |
location_notes | No | Notes for the occurrence/location entry. | Near trail marker 10 |
longitude | No | Longitude in decimal degrees (negative for west). | -60.12 |
x | No | Cartesian coordinate for individual within plot/transect, from origin | 10 |
y | No | Cartesian coordinate for individual within plot/transect. When transect, positive values for right-side and negative for left-side, from origin. | 5.1 |
locations (PUT)
Locations (GET lists, POST creates, PUT updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or location_id.) | 12 |
adm_level | No | Location administrative level code (e.g. 100=plot, 10=country). | 100 |
altitude | No | Elevation in meters. | 75 |
datum | No | Spatial datum/projection string. | EPSG:4326-WGS 84 |
geom | No | WKT geometry (POINT, LINESTRING, POLYGON, MULTIPOLYGON). | POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3)) |
ismarine | No | Flag to allow marine/offshore locations outside country polygons. | 1 |
lat | No | Latitude in decimal degrees (negative for south). | -3.101 |
location_id | No | Location id of the record to update. (Provide id or location_id.) | 44 |
long | No | Longitude in decimal degrees (negative for west). | -60.12 |
name | No | Translatable trait name. Accepts a plain string or a JSON map of language codes to names. | {"en":"Height","pt-br":"Altura"} |
notes | No | Free text or JSON notes field. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
parent | No | Parent id/name; for traits this is another trait export_name/id to define hierarchy. | woodDensity |
startx | No | Start X coordinate for subplot relative to parent plot. | 5.5 |
starty | No | Start Y coordinate for subplot relative to parent plot. | 10.0 |
x | No | X dimension for plots/transects | 100 |
y | No | Y dimension for plots or buffer for transects | 40 |
measurements (PUT)
Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or measurement_id.) | 12 |
bibreference | No | Bibreference id or bibkey. | 34 or ducke1953 |
dataset | No | Dataset id or acronym. | 3 or FOREST1 |
date | No | Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day. | 2024-05-20 or {\"year\":1888,\"month\":5} |
duplicated | No | Sequential number to allow duplicate measurements for same trait+object+date. | 2 for a second measurement, number 3 for third, ... |
link_id | No | Linked object id when trait type is Link. | taxon id 55 |
location | No | Location id or name. | Parcela 25ha or 55 |
measurement_id | No | Measurement id of the record to update. (Provide id or measurement_id.) | 77 |
notes | No | Free text or JSON notes field. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
object_id | No | Id of the measured object (Individual, Location, Taxon, Voucher or Media). | 4521 |
object_type | No | Measured object type: Individual, Location, Taxon, Voucher, or Media. | Individual |
parent_measurement | No | Parent measurement ID for measurements whose variable depends on the measurement of another variable | 3001 |
person | No | Person id, abbreviation, full name or email (supports lists with | or ;). | J.Silva|M.Costa |
trait_id | No | Trait id or export_name for measurements. | 12 or DBH |
value | No | Measurement payload varies by trait type: QUANT_INTEGER (0) = integer number; QUANT_REAL (1) = decimal number with dot separator; CATEGORICAL or ORDINAL (2/4) = single category id or translated name; CATEGORICAL_MULTIPLE (3) = list of category ids/names separated by | ; or , (or an array); TEXT (5) = free text string; COLOR (6) = hex color like #A1B2C3 or #ABC; LINK (7) = send link_id pointing to the linked object (value may be blank or a numeric qualifier); SPECTRAL (8) = semicolon-separated numeric series whose length equals trait value_length; GENEBANK (9) = GenBank accession string (validated against NCBI). | QUANT_REAL: 23.4 | CATEGORICAL: 15 | CATEGORICAL_MULTIPLE: 12|14 | SPECTRAL: 0.12;0.11;0.10 |
media (PUT)
Media metadata (GET lists, POST creates, PUT updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Single id or comma-separated list to filter or target records. (Provide id, media_id or media_uuid.) | 1,2,3 |
collector | No | Collector(s) id, abbreviation, name or email. Use | or ; to separate multiple people; first is main collector. | J.Silva|M.Costa |
dataset | No | Dataset id or acronym. | 3 or FOREST1 |
date | No | Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day. | 2024-05-20 or {\"year\":1888,\"month\":5} |
latitude | No | Latitude in decimal degrees (negative for south). | -3.101 |
license | No | Public license code for media (CC0, CC-BY, CC-BY-SA, etc.). | CC-BY-SA |
location | No | Location id or name. | Parcela 25ha or 55 |
longitude | No | Longitude in decimal degrees (negative for west). | -60.12 |
media_id | No | Media numeric id. (Provide id, media_id or media_uuid.) | 88 |
media_uuid | No | Media UUID. (Provide id, media_id or media_uuid.) | a3f0a4ac-6b5b-11ed-b8c0-0242ac120002 |
notes | No | Free text or JSON notes field. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
project | No | Project id or acronym. | PDBFF or 2 |
tags | No | Tag ids or names list for media or filters (use | or ;). | flower|leaf |
title_en | No | Media title in English. | Leaf detail |
title_pt | No | Media title in Portuguese. | Detalhe da folha |
persons (PUT)
People (GET lists, POST creates, PUT updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or person_id.) | 12 |
abbreviation | No | Standard abbreviation for a person or biocollection. | Silva, J.B, Pilco, M.V. |
biocollection | No | Biocollection id, name or acronym. | INPA |
email | No | Email address. | user@example.org |
full_name | No | Person full name. | Joao Silva |
institution | No | Institution associated with a person. | INPA |
person_id | No | Person id of the record to update. (Provide id or person_id.) | 12 |
vouchers (PUT)
Voucher specimens (GET lists, POST creates, PUT updates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Numeric ID of the record to be updated (Provide id or voucher_id.) | 12 |
biocollection | No | Biocollection id, name or acronym. | INPA |
biocollection_number | No | Catalogue number/code inside the biocollection. | 12345 |
biocollection_type | No | Nomenclatural type code or name. | Holotype or 2 |
clear_biocollection_number | No | When 1, clears the current biocollection_number on update. | 1 |
collector | No | Collector(s) id, abbreviation, name or email. Use | or ; to separate multiple people; first is main collector. | J.Silva|M.Costa |
dataset | No | Dataset id or acronym. | 3 or FOREST1 |
date | No | Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day. | 2024-05-20 or {\"year\":1888,\"month\":5} |
individual | No | Individual id, uuid or organismID (fullname). | 4521 or 2ff0e884-3d33 |
notes | No | Free text or JSON notes field. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
number | No | Collector number/code (voucher/individual tag when different from individual). | 1234A |
voucher_id | No | Voucher id of the record to update. (Provide id or voucher_id.) | 55 |
taxons (PUT)
Taxonomic names (GET lists, POST creates).
| Parameter | Required | Description | Example |
|---|---|---|---|
id | No | Required existing taxon id to update. taxon_id is accepted as an alias. (Provide id or taxon_id.) | 12 |
author | No | Taxon authorship string for published names. Unpublished names should leave this null and use author_id/person instead. | Smith & Jones |
author_id | No | Optional unpublished-author id. If present, the taxon is treated as unpublished for duplicate checking. | 25 |
bibkey | No | Optional bibreference id or bibkey to resolve bibreference_id. | ducke1953 or 34 |
bibreference | No | Bibreference id or bibkey. | 34 or ducke1953 |
bibreference_id | No | BibReference id list for voucher filtering. | 10,11 |
enforceValid | No | Optional boolean override for published-name updates. Use when you intentionally want to keep valid=true even though the API reports the name as invalid and returns a senior name. | 1 or true |
gbif | No | Optional explicit GBIF id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation. | 28792 |
indexfungorum | No | Index Fungorum identifier for a taxon. | IF123456 |
ipni | No | Optional explicit IPNI id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation. | 123456-1 |
level | No | Optional new rank code or rank name. Required when changing unpublished taxa in a way that needs rank validation and always checked against the parent. | 210 or species |
mobot | No | Optional explicit Tropicos/MOBOT id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation. | 25509881 |
mycobank | No | Optional explicit MycoBank id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation. | MB123456 |
name | No | Optional new taxon name. If the taxon is published and name changes, external APIs are used again and may overwrite informed parent, rank, validity, senior_id, authorship, bibreference, and external ids. If the taxon is unpublished and name changes, duplicate checks are applied instead of API lookup. | Ocotea guianensis |
notes | No | Optional replacement for notes. Accepts a plain string or a JSON string. | {"reviewed_by":"J. Silva"} |
parent | No | Optional new parent id or scientific name. All name updates and parent changes are revalidated against taxon-level rules. | Ocotea or 120 |
parent_id | No | Parent id for hierarchical queries. | 210 |
parent_name | No | Alternative parent taxon name used by taxon imports and updates. | Ocotea |
person | No | Optional author reference for unpublished taxa. Accepts person id, abbreviation, full name, or email and resolves to author_id. | 25 or Pilco, M.V. |
senior_id | No | Optional accepted-name taxon id. Allowed only when valid=false. The referenced senior taxon must be valid and published; unpublished senior names are rejected. | 345 |
taxon_id | No | Alias of id for update payloads. (Provide id or taxon_id.) | 12 |
valid | No | Optional boolean. Both published and unpublished taxa may be invalid. If set to true, senior_id is cleared. If set to false on a published name, senior_id must be informed. If you send valid=true for a published-name rename and the API says the name is invalid, the update is rejected unless enforceValid=true is also sent. | 1 or 0 |
zoobank | No | Optional explicit ZooBank id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation. | urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |