Description
This method removes a static segment from your account. All subscribers assigned to this static segment will remain within the system, but they will no longer be associated with this static segment.
If you just want to remove subscribers from a segment, then use the legacy.group_clear method.
Arguments
Field | Description | Field Type | Required | Example |
---|---|---|---|---|
id | The ID number of the static segment to be deleted. The ID number is returned in the response XML message from the account.addStaticSegment method call.Use the account.getStaticSegments method to retrieve the full set of static segments created for your account. You can also find the ID number of a specific static segment by logging into the application and navigating to Administration > Account and Segment IDs and then scrolling to the Segment section. | number | Yes | 852869 |
Response
Field | Description | Example |
---|---|---|
responseCode | A code indicating either success or failure of the operation. (see Error Codes below) | 116 |
responseText | Human readable description of the response code | This static segment has been removed |
id | The ID number of the static segment being removed. | 852869 |
Response Codes
Error Condition | responseCode | responseText |
---|---|---|
The static segment ID provided in the input XML message either does not exist for the account, or it is not a valid number. | 114 | action not taken, invalid segment id |
Successful operation | 116 | this static segment has been removed |
Example Post
<methodCall>
<methodName>account.removeStaticSegment</methodName>
<id>852869</id>
</methodCall>
Example Response
<methodResponse>
<item>
<methodName><![CDATA[account.removeStaticSegment]]></methodName>
<responseCode><![CDATA[116]]></responseCode>
<responseText><![CDATA[this static segment has been removed]]></responseText>
<responseData>
<id><![CDATA[852869]]></id>
</responseData>
<responseNum><![CDATA[1]]></responseNum>
</item>
</methodResponse>
Example Error
<methodResponse>
<item>
<methodName><![CDATA[account.removeStaticSegment]]></methodName>
<responseCode><![CDATA[114]]></responseCode>
<responseText><![CDATA[action not taken, invalid id]]></responseText>
<responseData>
<id><![CDATA[852869]]></id>
</responseData>
<responseNum><![CDATA[1]]></responseNum>
</item>
</methodResponse>