update_supp_field_m Sample Call and Response
This example shows a client updating an existing supplemental account field, “Preferred Contact Method,” to change its description and display order and to add a fourth selection option. It is based on the update_supp_field_m method as defined in methods_m_r73.yml, Admin Tools API. This method updates a supplemental field on the account, which is distinct from update_supp_obj_field_m, which updates a supplemental field on a product-level object such as a plan.
This example includes the required field, plus a representative set of optional fields describing a select-style field with four selection options. It does not attempt to show every optional field the method accepts.
Sample call
{
"rest_call": "update_supp_field_m",
"output_format": "json",
"client_no": 700123,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"field_name": "Preferred Contact Method",
"field_desc": "Indicates how the account holder prefers to be contacted regarding billing and service matters.",
"field_order": 3,
"required_ind": 0,
"hidden_ind": 0,
"sel_ind": 1,
"presentation_mode": "select",
"min_no_sel": 1,
"max_no_sel": 1,
"display_text": ["Email", "Phone", "Postal Mail", "Text Message"],
"option_value": ["EMAIL", "PHONE", "MAIL", "TEXT"],
"option_value_order": [1, 2, 3, 4]
}
The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call. field_name is the only required field, and it identifies which existing supplemental account field this call updates. presentation_mode remains “select,” one of the valid form input types alongside text, textarea, radio, and checkbox, and sel_ind remains 1, meaning the field still offers selection options. Because presentation_mode is select, display_text, option_value, and option_value_order are supplied together; each is declared in the method as its own repeatable field rather than as one nested group, so this example represents the four selection options as three parallel arrays, position by position, rather than as an array of four combined objects. The first three positions preserve the original “Email,” “Phone,” and “Postal Mail” options, and the fourth position adds a new “Text Message” option with the value “TEXT” at display order four. field_order is changed from its original value to 3, moving the field earlier in the presentation order. As the yml notes, several of these fields, including required_ind, hidden_ind, sel_ind, presentation_mode, min_no_sel, max_no_sel, and the selection-option fields, are ignored if at least one account already carries a value for this supplemental field.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"field_name": "Preferred Contact Method"
}
An error_code of zero, paired with an error_msg of “OK,” indicates that Aria updated the supplemental account field successfully. The field_name field echoes back the name of the field that was updated. The method’s returns block consists only of these three fields, so there is no additional output to show.