Retrieve organization entries or update an organization's options.

post/organization

Request

Request body

organizationIdstring

organization ID

tagOptionsobject

Customization options for tags

labelstring

label

descriptionstring

This is a description of an organization

massUnitOptionstring

The preferred display unit for mass

areaUnitOptionstring

The preferred display unit for area

emailFrequencyOptionstring

email frequency option

webhookUrlstring

webhook url

webhookSecretstring

webhook secret

Example request

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "massUnitOption": "t",
  "areaUnitOption": "ha",
  "emailFrequencyOption": "daily",
  "webhookUrl": "https://example.com",
  "webhookSecret": "12341234-1234-1234-1234-123412341234"
}

Response

Success

organizationIdstring

organization ID

tagOptionsobject

Customization options for tags

labelstring

The name of the organization

massUnitOptionstring

The preferred display unit for mass

areaUnitOptionstring

The preferred display unit for area

emailFrequencyOptionstring

Email frequency option for the organization, valid values are currently only 'every' and 'never'

webhookUrlstring

webhook url

webhookSecretstring

webhook secret

Example response

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "massUnitOption": "t",
  "areaUnitOption": "ha",
  "emailFrequencyOption": "never",
  "webhookUrl": "https://example.com",
  "webhookSecret": "12341234-1234-1234-1234-123412341234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.