myCC - Plants

Updates plant groups

  • To add a plant to a group, include all plant IDs (including the one to add) in the PlantIds array. Set PreviousGroupName as null.
  • To remove a plant from a group, set GroupName to the relevant group and exclude the plant ID from the plantIds array. Include the plant IDs of plants that need to remain in the group.
  • To rename a group, set PreviousGroupName to the old name, GroupName to the new name, and include all Plants that should retain the new name in the PlantIds array.
put/Accounts/{accountId}/Plants/Groups

Request

  • Base URL: https://api.carboncure.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.carboncure.com/Accounts/{accountId}/Plants/Groups
  • Auth: one of:
    • none
    • OAuth 2 (authorization code, authorization URL https://auth.carboncure.com/oauth2/authorize, token URL https://auth.carboncure.com/oauth2/token, scopes: applicationId, roles)
    • none

Path parameters

accountIdinteger required

MyCC account ID associated with plants.

Request body

groupNamestring nullable
previousGroupNamestring nullable
plantIdsinteger[] nullable

Response

OK

Changes

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