KB Newsman
Newsman Api Method: newsletter.restart
Prototype: newsletter.restart(newsletter_id)
Description: Restarts a cancelled / sent newsletter
HTTP method: POST
Endpoint HTTP: /newsletter.restart.json
Endpoint XML-RPC: newsletter.restart
Return type: booleanReturn info: True if the operation was ok, false otherwise
Request parameters POST
| Variable | Type | Description |
|---|---|---|
| newsletter_id | string|int | The ID of the newsletter to be restarted |
Response parameters
| Parameter | Description |
|---|---|
| boolean | True if the update has succeeded, False otherwise |
Output example
trueResponse Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param newsletter_id | newsletter_id param is required |
| 131 | No such newsletter with ID: %s. | Invalid access to newsletter_id |
| 1312 | Newsletter %s can't restart. Only sent newsletters may be restarted | This newsletter cannot be restarted |
Error examples
{ "err": true, "message": "Missing required param newsletter_id", "code": 407 }