Skip to main content
PUT
/
organizations
/
{orgId}
/
plangrouplinks
/
{id}
Update PlanGroupLink
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/plangrouplinks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planGroupId": "<string>",
  "planId": "<string>",
  "version": 123
}
'
{
  "id": "<string>",
  "version": 123,
  "planGroupId": "<string>",
  "planId": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

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

​
id
string
required

The UUID of the PlanGroupLink to update.

Body

application/json
​
planGroupId
string
required
Minimum string length: 1
​
planId
string
required
Minimum string length: 1
​
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.

Response

Return the updated PlanGroup

​
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.
​
planGroupId
string

ID of the linked PlanGroup

​
planId
string

ID of the linked Plan

​
dtCreated
string<date-time>

The DateTime (in ISO-8601 format) when the plan group link was created.

​
dtLastModified
string<date-time>

The DateTime (in ISO-8601 format) when the plan group link was last modified.

​
createdBy
string

The id of the user who created this plan group link.

​
lastModifiedBy
string

The id of the user who last modified this plan group link.