---
title: "Update CustomFields"
method: PUT
path: "/organizations/{orgId}/customfields"
tags: ["CustomField"]
---

# Update CustomFields

`PUT /organizations/{orgId}/customfields`

Update Custom Fields added at Organization level to entities that support them.

## Path parameters

- `orgId` string, required

## Request body

- CustomFieldRequest
  - `version` integer — The version number of the entity: - **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response. - **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
  - `organization` object — Updates to Organization CustomFields.
  - `account` object — Updates to Account entity CustomFields.
  - `accountPlan` object — Updates to AccountPlan entity CustomFields.
  - `meter` object — Updates to Meter entity CustomFields.
  - `product` object — Updates to Product entity CustomFields.
  - `planTemplate` object — Updates to planTemplate entity CustomFields.
  - `plan` object — Updates to Plan entity CustomFields.
  - `aggregation` object — Updates to simple Aggregation entity CustomFields.
  - `compoundAggregation` object — Updates to Compound Aggregation entity CustomFields.
  - `contract` object — Updates to Contract entity CustomFields.

## Response `200`

Return the updated CustomFields

- CustomFieldResponse
  - `id` string, required — The UUID of the entity.
  - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
  - `organization` object — CustomFields added to the Organization.
  - `account` object — CustomFields added to Account entities.
  - `accountPlan` object — CustomFields added to accountPlan entities.
  - `meter` object — CustomFields added to Meter entities.
  - `product` object — CustomFields added to Product entities.
  - `planTemplate` object — CustomFields added to planTemplate entities.
  - `plan` object — CustomFields added to Plan entities.
  - `aggregation` object — CustomFields added to simple Aggregation entities.
  - `compoundAggregation` object — CustomFields added to Compound Aggregation entities.
  - `contract` object — CustomFields added to Contract entities.
  - `dtCreated` string, date-time — The DateTime when the Organization was created *(in ISO-8601 format)*.
  - `dtLastModified` string, date-time — The DateTime when a custom field was last modified - created, modified, or deleted - for the Organization *(in ISO-8601 format)*.
  - `createdBy` string — The id of the user who created this custom field.
  - `lastModifiedBy` string — The id of the user who last modified this custom field.

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)