KB Newsman
Newsman Api Method: segment.clear
Prototype: segment.clear(segment_id)
Description: Removes all subscribers from this segment
HTTP method: POST
Endpoint HTTP: /segment.clear.json
Endpoint XML-RPC: segment.clear
Return type: booleanReturn info: True if clear was ok, false otherwise
Request parameters POST
| Variable | Type | Description |
|---|---|---|
| segment_id | int|string | The ID of the segment from which to remove the subscribers |
Response parameters
| Parameter | Description |
|---|---|
| boolean | True if the clear has succeeded, False otherwise |
Output example
trueResponse Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param segment_id | segment_id param is required |
| 141 | No such segment with ID: %s. | Invalid access to segment_id |
| 141 | Segment %s has been deleted. | Segment has been deleted |
| 144 | Cannot clear this segment | Cannot clear this segment |
Error examples
{ "err": true, "message": "Missing required param segment_id", "code": 407 }