Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Concepts in Bulk

Update up to 100 concepts in a single request.

put/v2/locations/concepts

Query parameters

inheritLocaleboolean

When true, locale fields are inherited from the parent concept when not explicitly provided.

Request body

identifierName'ID' | 'CODE' | 'EXTERNAL_ID' required

How to identify the target concept. One of ID, CODE, EXTERNAL_ID (case-insensitive).

identifierValuestring required

The identifier value matching identifierName.

namestring

Display name for the concept. Cannot be null or empty. Cannot equal ROOT (any case). Max 100 characters. Accepts letters, digits, underscores, and spaces.

descriptionstring nullable

Free-text description. Set to null to clear.

isAdminboolean

Whether the concept has admin access.

isActiveboolean

Whether the concept is active. Deactivation fails if children are active. Activation fails if parent is inactive.

isOrgUnitboolean

Whether the concept functions as an organizational unit.

groupParentCodestring

Code of the parent concept. Cannot be set to null. Provide a valid concept code to change the parent.

externalIdsobject nullable

Key-value map of external identifiers. Omit to preserve. Pass null to clear all external identifiers. Pass {} to make no change. Set a key's value to null to remove that specific key. Maximum five entries. Keys and values must not exceed 200 characters each.

customFieldsobject nullable

Key-value map of custom field values. Omit to preserve. Pass null to clear all custom field values. Pass {} to make no change. Keys must match custom fields configured for the org.

languagestring

IETF BCP 47 language code (e.g. en-IN). Must be enabled for the org.

currencystring

ISO 4217 currency code (e.g. INR). Must be enabled for the org.

timezonestring

IANA timezone name (e.g. Asia/Kolkata). Must be enabled for the org.

Response

All concepts updated successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.