Update an email template translation
patch
/crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}
Request
Path Parameters
-
EmailTemplateTranslationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TemplateId and Language ---for the Email Template Translations resource and used to uniquely identify an instance of Email Template Translations. The client should not generate the hash key value. Instead, the client should query on the Email Template Translations collection resource with a filter on the primary key values in order to navigate to a specific instance of Email Template Translations.
For example: EmailTemplateTranslations?q=TemplateId=<value1>;Language=<value2> -
TemplateNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EmailBody: string
(byte)
The content of the email body.
-
EmailSubject: string
Maximum Length:
2000
The subject of an email template. -
Language: string
Maximum Length:
4
The language of an email template. -
SourceLang: string
Maximum Length:
4
The source language of an email template. -
TemplateDescription: string
Maximum Length:
2000
The description of an email template. -
TemplateId: integer
(int64)
The primary key of an email template.
-
TemplateName: string
Maximum Length:
240
The name of an email template.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : emailTemplates-EmailTemplateTranslations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the email template translation. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the email template translation was created. -
EmailBody: string
(byte)
The content of the email body.
-
EmailSubject: string
Maximum Length:
2000
The subject of an email template. -
Language: string
Maximum Length:
4
The language of an email template. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the email template translation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the email template translation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceLang: string
Maximum Length:
4
The source language of an email template. -
TemplateDescription: string
Maximum Length:
2000
The description of an email template. -
TemplateId: integer
(int64)
The primary key of an email template.
-
TemplateName: string
Maximum Length:
240
The name of an email template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.