The editCustomListField() method updates a single custom list field from the VR mailing custom list fields.
Optionally allows to set this custom list field size to “small”, “medium” and “large”;
Optionally, truncate data is used along with the custom list field width when decreasing a custom list field size.
One of the two arguments should be present in the method call.
Optionally allows to set this custom list field size to “small”, “medium” and “large”;
Optionally, truncate data is used along with the custom list field width when decreasing a custom list field size.
One of the two arguments should be present in the method call.
Input
[vrtypens:editCustomListFieldArgs]
session_id [xsd:string] (required)
Your API session id.
field_name [xsd:string] (required)
The field name to edit
new_width [xsd:string]
The field new width to be updated.
Allowed widths “small”, “medium”, “large”
Allowed widths “small”, “medium”, “large”
truncate_data [xsd:boolean]
Truncate data is used along with the custom list field width when decreasing a custom list field size.
It is ignored when increasing the custom list field width.
It is ignored when increasing the custom list field width.
Output
[xsd:boolean]
Examples
Perl
$vrapi->editCustomListField( {
session_id => $sid,
field_name => $field_name
new_width => 'large'
},
} );
$vrapi->editCustomListField( {
session_id => $sid,
field_name => $field_name
new_width => 'small'
truncate_data => true
},
} );
PHP
$vrapi->editCustomListField( array(
'session_id' => $sid,
'field_name' => $field_name
'new_width' => 'large'
) );
$vrapi->editCustomListField( array(
'session_id' => $sid,
'field_name' => $field_name
'new_width' => 'small'
'truncate_data' => true
) );
Ruby
vr.editCustomListField({
'session_id' => sid,
'field_name' => field_name
'new_width' => 'large'
})
vr.editCustomListField({
'session_id' => sid,
'field_name' => field_name
'new_width' => 'small'
'truncate_data => true
})