Skip to content

Update Template Groups

Updates the specified template group(s).

Note

A template group cannot be moved to a different organization on update; its organizationId is fixed. The organizationId field is still required in the request body, but any value other than the group's current organization is ignored rather than rejected.

Verb PATCH
Endpoint {base-url}/template-groups/
Max Page Size N/A

Request body

{
  "body": [
    {
      "id": 3,
      "name": "Standard",
      "description": "updated description",
      "organizationId": 1
    }
  ]
}

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

The updated template group(s).

Response body

[
  {
    "id": 3,
    "name": "Standard",
    "description": "updated description",
    "createdAt": "2021-09-09T15:02:37.403",
    "organizationId": 1
  }
]

On Error

HTTP Code Error Code Definition
403 DATA_ACCESS_VIOLATION One or more of the specified template group id values belong to an organization you do not have access to.
404 MISSING_RECORD One or more of the specified template group id values does not exist.
422 VALIDATION_ERROR A required field is missing or invalid (e.g. name is required and must be 100 characters or fewer, description must be 200 characters or fewer, organizationId must be a positive integer).