Skip to main content
Aria Knowledge Central

get_email_templates_m

Summary

API Name get_email_templates_m
Class system_services_m
Update Version 6.32

Description

Returns the list of email templates associated with a client.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

filter_template_class string   No

Filter by Aria class assigned to each email template

Outputs

Name Type Length Required Description
Start of templates_by_client object
templates_by_client object   No  
Name Type Length Required Description
▶template_no long   No

Aria-assigned unique identifier indicating each email template created in Aria.

▶template_name string   No

User-assigned name for email template

▶template_class string   No

Aria class assigned to each email template

Allowed values:

Value Description
R Contract Expiry/Renewal
I Invoice/Statement
D Dunning
A Account Activation
W Account Welcome
C Credit Card Expiry
T Account Termination
O Other
B Broadcast
P Password Reminder/Reset
S Service Plan Change
U UnKnown
N Account Comment/Note
Z ARC Resource Threshold Warning
IM Messenger Template
IS Invoice Subtemplate
S2 Supplemental Service Plan Change
C2 Electronic Collection Attempt
UMO MID Usage Threshold Over
UPO PTD Usage Threshold Over
UMU MTD Usage Threshold Under
UPU PTD Usage Threshold Under
▶client_email_template_id string 100 No

Client assigned unique ID for email template

▶global_ind long 1 No

Indicates that email template is global or custom to client

Allowed values:

Value Description
1 The email template is global
0 The email template is custom to client
▶default_ind long 1 No

Indicates that email template is default for the template class or not

Allowed values:

Value Description
1 The email template is default
0 The email template is not default
End of templates_by_client object
error_code long   No

Aria-assigned error identifier. 0 indicates no error.

error_msg string   No

Description of any error that occurred. "OK" if there was no error.

TOP
  • Was this article helpful?