WARNING: This method cannot be combined with any other method call within the same POST command.
This method removes all contacts from a static segment. The contacts themselves remain within the subscriber database. This is a handy method to use when marketers want to "reset" the membership of a particular static segment in anticipation of a specific campaign. Removing the static segment is also good for just routine housekeeping.
If you just want to remove a static segment itself, then use the account.removeStaticSegment method.
|group_id||A single or comma-delimited list of static segment ID numbers. To view a list of static segments and their corresponding ID numbers, log in to the application and navigate to Administration > Configure Settings > Account and Segment IDs. Scroll down on the screen to the Segments section to find the static segment name and its corresponding segment ID.
There is a limit of 100 segment IDs that you can include within the comma-delimited list.
|delete||A boolean value where:
|notify_email||The email address that a completion notification email should be sent to.||String||Nofirstname.lastname@example.org|
|message||Indicates whether the deletion job was successfully inserted into the BlueHornet job engine. NOTE: The response is not an indication that the subscribers have been deleted from the static segment.
|job_id||The JOB_ID associated with the deletion request. To view a list of JOB_IDs, log in to the application and navigate to Administration > View Tasks.||862726|
|reason||This element is included if the <message> element is set to '2'. It will explain the reason for the deletion failure.||"Not all values passed through"|
|2||Not all values passed through||The POSTed XML message is missing the required element|
|2||Max number of groups was exceeded||There were more than 100 static segment IDs included in the comma-delimited list.|
<reason>not all values passed through</reason>