Req | Field Name | Field Type | Max Length | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||||||
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||||||
![]() |
user_id | string | 32 | Account's user ID. | ||||||||||||
template_class | string | 8 | Email Template Class is the category of email templates to choose from. If template_class is provided, the template_no input will be ignored.
|
|||||||||||||
template_no | long | 8 | The Aria-generated number of the template to use for sending email. Used only when template_class is not provided. | |||||||||||||
OR | ||||||||||||||||
client_template_id | string | 100 | The client-defined specific Email Template to send | |||||||||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||||||||
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |