Skip to main content
PUT
/
organizations
/
{orgId}
/
customfields
Update CustomFields
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/customfields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 6,
  "organization": {
    "Org Example 2": "Sample text 2.",
    "Org Example 1": "Sample text 1."
  },
  "account": {},
  "accountPlan": {
    "New CF Test": "Test Value"
  },
  "meter": {},
  "product": {
    "Product CF Example": 42
  },
  "planTemplate": {},
  "plan": {},
  "aggregation": {},
  "compoundAggregation": {}
}
'
{
  "id": "81c49a54-dfcd-4da5-bbf3-d2885ec025dd",
  "version": 4,
  "organization": {
    "Org Example 2": "Sample text 2.",
    "Org Example 1": "Sample text. "
  },
  "product": {
    "Product CF Example": 42
  },
  "account": {},
  "accountPlan": {
    "New CF Test": "Test Value"
  },
  "meter": {},
  "planTemplate": {},
  "plan": {},
  "aggregation": {},
  "compoundAggregation": {}
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Body

application/json
​
version
integer<int64>

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

Return the updated CustomFields

​
id
string
required

The UUID of the entity.

​
version
integer<int64>

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.