create_acct_message_m
Summary
| API Name | create_acct_message_m |
|---|---|
| Class | account_services_m |
| Update Version | 74 |
Description
Creates and sends a specified message type to a particular account holder. All message content, including the recipient email address, is supplied by the caller in the message_content JSON payload.
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 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||
| acct_no | long | 22 | Yes |
The account number of the account to which the message is sent. Alternative required field: client_acct_id |
||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||||
| template_class | string | 8 | Yes |
The third party message template class to use. Allowed values:
|
||||||||||
| alt_template_no | long | 8 | No |
An alternate template number that overrides the default template for the given class. |
||||||||||
| billing_group_no | long | 22 | No |
The billing group number; if provided, uses the billing group-level contact and template group settings. Cannot be provided together with master_plan_instance_no. |
||||||||||
| master_plan_instance_no | long | 22 | No |
The master plan instance number; if provided, uses the master plan instance-level settings. Cannot be provided together with billing_group_no. |
||||||||||
| message_content | string | No |
Dynamic content for the message in JSON format. Carries all replacement values and the recipient email address for the message. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| 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. |