Skip to content

Update Template

connectcases_update_template R Documentation

Updates the attributes of an existing template

Description

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Usage

connectcases_update_template(description, domainId, layoutConfiguration,
  name, requiredFields, status, templateId)

Arguments

description

A brief description of the template.

domainId

[required] The unique identifier of the Cases domain.

layoutConfiguration

Configuration of layouts associated to the template.

name

The name of the template. It must be unique per domain.

requiredFields

A list of fields that must contain a value for a case to be successfully created with this template.

status

The status of the template.

templateId

[required] A unique identifier for the template.

Value

An empty list.

Request syntax

svc$update_template(
  description = "string",
  domainId = "string",
  layoutConfiguration = list(
    defaultLayout = "string"
  ),
  name = "string",
  requiredFields = list(
    list(
      fieldId = "string"
    )
  ),
  status = "Active"|"Inactive",
  templateId = "string"
)