List PlanGroups
Function name:m3ter_ListPlanGroups
Category: READ
HTTP method: GET (paginated)
Destination: m3ter
Retrieve a list of PlanGroups.
Retrieves a list of PlanGroups within the specified organization. You can optionally filter by Account IDs or PlanGroup IDs, and also paginate the results for easier management.
Parameters
Exits
Create PlanGroup
Function name:m3ter_PostPlanGroup
Category: WRITE
HTTP method: POST
Destination: m3ter
Create a new PlanGroup.
This endpoint creates a new PlanGroup within the specified organization.
Parameters
Exits
Retrieve PlanGroup
Function name:m3ter_GetPlanGroup
Category: READ
HTTP method: GET
Destination: m3ter
Retrieve a specific PlanGroup with the given UUID.
This endpoint retrieves detailed information about a specific PlanGroup identified by the given UUID within a specific organization.
Parameters
Exits
Update PlanGroup
Function name:m3ter_PutPlanGroup
Category: WRITE
HTTP method: PUT
Destination: m3ter
Update the PlanGroup with the given UUID.
This endpoint updates the details of a specific PlanGroup identified by the given UUID within a specific organization. This allows modifications to existing PlanGroup attributes.
Note: If you have created Custom Fields for a PlanGroup, when you use this endpoint to update the PlanGroup use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.
Parameters
Exits
Delete PlanGroup
Function name:m3ter_DeletePlanGroup
Category: WRITE
HTTP method: DELETE
Destination: m3ter
Delete a PlanGroup with the given UUID.
This endpoint deletes the PlanGroup identified by the given UUID within a specific organization. This operation is irreversible and removes the PlanGroup along with any associated settings.