Update Template

put https://example.com/settings/v1/templates/{templateId}

Update Template

Performs full update, the values will be replaced with values that are specified in the request

Request Body Parameters:

Parameter	Type	Mandatory	Description
displayName	string	true
name	string	true	Pattern:[a-zA-Z]\w*
description	string	false
ownerOrganizationId	string	false
parentTemplateId	string	false
forceUpdate	boolean	false
customAttributes	array	false
customAttributes[index]	array	false
customAttributes[index].displayName	string	true
customAttributes[index].phi	boolean	false
customAttributes[index].referenceConfiguration	object	false
customAttributes[index].referenceConfiguration.uniquely	boolean	false
customAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
customAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
customAttributes[index].referenceConfiguration.entityType	string	true
customAttributes[index].linkConfiguration	object	false
customAttributes[index].linkConfiguration.entityTypeName	string	true
customAttributes[index].linkConfiguration.templateId	string	true
customAttributes[index].linkConfiguration.attributeId	string	true
customAttributes[index].name	string	true	Pattern:[a-zA-Z]\w*
customAttributes[index].type	string	true	Values:LABEL,PARAGRAPH,INTEGER,DECIMAL,BOOLEAN,SINGLE_SELECT,MULTI_SELECT,ADDRESS,NAME,PHONE,EMAIL,DATE_TIME,DATE,REFERENCE,TIMEZONE,LOCALE,FILE,IMAGE,LINK,WAVEFORM
customAttributes[index].validation	object	false
customAttributes[index].validation.mandatory	boolean	true
customAttributes[index].validation.defaultValue	object	false
customAttributes[index].validation.min	number	false
customAttributes[index].validation.max	number	false
customAttributes[index].validation.regex	string	false
customAttributes[index].numericMetaData	object	false
customAttributes[index].numericMetaData.units	string	false
customAttributes[index].numericMetaData.upperRange	number	false
customAttributes[index].numericMetaData.lowerRange	number	false
customAttributes[index].numericMetaData.subType	string	false	Values:INTEGER,DECIMAL
customAttributes[index].id	string	false
customAttributes[index].selectableValues	array	false
customAttributes[index].selectableValues[index]	array	false
customAttributes[index].selectableValues[index].name	string	true	Pattern:[a-zA-Z]\w*
customAttributes[index].selectableValues[index].displayName	string	true
customAttributes[index].selectableValues[index].id	string	false
customAttributes[index].category	string	true
builtInAttributes	array	false
builtInAttributes[index]	array	false
builtInAttributes[index].id	string	true
builtInAttributes[index].displayName	string	true
builtInAttributes[index].phi	boolean	false
builtInAttributes[index].referenceConfiguration	object	false
builtInAttributes[index].referenceConfiguration.uniquely	boolean	false
builtInAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
builtInAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
builtInAttributes[index].referenceConfiguration.entityType	string	true
builtInAttributes[index].linkConfiguration	object	false
builtInAttributes[index].linkConfiguration.entityTypeName	string	true
builtInAttributes[index].linkConfiguration.templateId	string	true
builtInAttributes[index].linkConfiguration.attributeId	string	true
builtInAttributes[index].validation	object	false
builtInAttributes[index].validation.mandatory	boolean	true
builtInAttributes[index].validation.defaultValue	object	false
builtInAttributes[index].validation.min	number	false
builtInAttributes[index].validation.max	number	false
builtInAttributes[index].validation.regex	string	false
builtInAttributes[index].numericMetaData	object	false
builtInAttributes[index].numericMetaData.units	string	false
builtInAttributes[index].numericMetaData.upperRange	number	false
builtInAttributes[index].numericMetaData.lowerRange	number	false
builtInAttributes[index].numericMetaData.subType	string	false	Values:INTEGER,DECIMAL
templateAttributes	array	false
templateAttributes[index]	array	false
templateAttributes[index].id	string	true
templateAttributes[index].displayName	string	true
templateAttributes[index].phi	boolean	false
templateAttributes[index].referenceConfiguration	object	false
templateAttributes[index].referenceConfiguration.uniquely	boolean	false
templateAttributes[index].referenceConfiguration.referencedSideAttributeName	string	false
templateAttributes[index].referenceConfiguration.validTemplatesToReference	array	false
templateAttributes[index].referenceConfiguration.entityType	string	true
templateAttributes[index].linkConfiguration	object	false
templateAttributes[index].linkConfiguration.entityTypeName	string	true
templateAttributes[index].linkConfiguration.templateId	string	true
templateAttributes[index].linkConfiguration.attributeId	string	true
templateAttributes[index].value	object	false
templateAttributes[index].organizationSelectionConfiguration	object	false
templateAttributes[index].organizationSelectionConfiguration.selected	array	false
templateAttributes[index].organizationSelectionConfiguration.selected[index]	array	false
templateAttributes[index].organizationSelectionConfiguration.selected[index].id	string	true
templateAttributes[index].organizationSelectionConfiguration.all	boolean	false

Path Parameters:

Parameter	Type	Mandatory	Description	Example
templateId	string	true	null

This API requires SETTINGS_UPDATE_TEMPLATE permission(s).