Skip to content

mail_template

Manage mail templates

Create

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

Input parameters

Layout
object
Namespace
mail_template
ParameterTypeRequiredDetails
name
Name
 String no

Template identifier

Default: null
label
Label
 String no

Human-friendly label

Default: null
template_id
Template_id
 String no

Default: null
user_visibility
User_visibility
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • default
  • visible
  • invisible

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
mail_template
ParameterTypeDescription
id
Id
 Integer
name
Name
 String Template identifier
label
Label
 String Human-friendly label
template_id
Template_id
 String
user_visibility
User_visibility
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

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

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/mail_templates
Description
List mail templates
Authentication required
yes
Scope
mail_template#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
mail_template
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
mail_templates
ParameterTypeDescription
id
Id
 Integer
name
Name
 String Template identifier
label
Label
 String Human-friendly label
template_id
Template_id
 String
user_visibility
User_visibility
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

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

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
mail_template
ParameterTypeDescription
id
Id
 Integer
name
Name
 String Template identifier
label
Label
 String Human-friendly label
template_id
Template_id
 String
user_visibility
User_visibility
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

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

Input parameters

Layout
object
Namespace
mail_template
ParameterTypeRequiredDetails
name
Name
 String no

Template identifier

Default: null
label
Label
 String no

Human-friendly label

Default: null
template_id
Template_id
 String no

Default: null
user_visibility
User_visibility
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • default
  • visible
  • invisible

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
mail_template
ParameterTypeDescription
id
Id
 Integer
name
Name
 String Template identifier
label
Label
 String Human-friendly label
template_id
Template_id
 String
user_visibility
User_visibility
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Subresources