Skip to content

mail_template.translation

Manage mail templates

Create

Path
POST /v7.0/mail_templates/{mail_template_id}/translations
Description
Create a mail template translation
Authentication required
yes
Scope
mail_template.translation#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
translation
ParameterTypeRequiredDetails
language
Language
 Resource no
from
From
 String no

Default: null
reply_to
Reply_to
 String no

Default: null
return_path
Return_path
 String no

Default: null
subject
Subject
 String no

Default: null
text_plain
Text_plain
 Text no

Default: null
text_html
Text_html
 Text no

Default: null

Output parameters

Layout
object
Namespace
translation
ParameterTypeDescription
id
Id
 Integer
language
Language
 Resource
from
From
 String
reply_to
Reply_to
 String
return_path
Return_path
 String
subject
Subject
 String
text_plain
Text_plain
 Text
text_html
Text_html
 Text
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/mail_templates/{mail_template_id}/translations/{translation_id}
Description
Delete a mail template translation
Authentication required
yes
Scope
mail_template.translation#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/mail_templates/{mail_template_id}/translations
Description
List mail template translations
Authentication required
yes
Scope
mail_template.translation#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
translation
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
translations
ParameterTypeDescription
id
Id
 Integer
language
Language
 Resource
from
From
 String
reply_to
Reply_to
 String
return_path
Return_path
 String
subject
Subject
 String
text_plain
Text_plain
 Text
text_html
Text_html
 Text
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/mail_templates/{mail_template_id}/translations/{translation_id}
Description
Show a mail template translation
Authentication required
yes
Scope
mail_template.translation#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
translation
ParameterTypeDescription
id
Id
 Integer
language
Language
 Resource
from
From
 String
reply_to
Reply_to
 String
return_path
Return_path
 String
subject
Subject
 String
text_plain
Text_plain
 Text
text_html
Text_html
 Text
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/mail_templates/{mail_template_id}/translations/{translation_id}
Description
Update a mail template translation
Authentication required
yes
Scope
mail_template.translation#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
translation
ParameterTypeRequiredDetails
language
Language
 Resource no
from
From
 String no

Default: null
reply_to
Reply_to
 String no

Default: null
return_path
Return_path
 String no

Default: null
subject
Subject
 String no

Default: null
text_plain
Text_plain
 Text no

Default: null
text_html
Text_html
 Text no

Default: null

Output parameters

Layout
object
Namespace
translation
ParameterTypeDescription
id
Id
 Integer
language
Language
 Resource
from
From
 String
reply_to
Reply_to
 String
return_path
Return_path
 String
subject
Subject
 String
text_plain
Text_plain
 Text
text_html
Text_html
 Text
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime