KB Newsman
Newsman Api Method: newsletter.schedule
Prototype: newsletter.schedule(newsletter_id, schedule_time)
Description: Schedules a newsletter to be sent in the future
HTTP method: POST
Endpoint HTTP: /newsletter.schedule.json
Endpoint XML-RPC: newsletter.schedule
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 for which to set the schedule |
| schedule_time | string | The schedule UNIVERSAL Time (UTC / GMT+0), format: YYYY-MM-DD HH:II:SS |
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 schedule. | This newsletter cannot be assigned a schedule |
| 136 | Invalid schedule date/time. | The schedule is not valid |
| 136 | Invalid schedule date/time. | Ora de trimitere nu este validă |
Error examples
{ "err": true, "message": "Missing required param newsletter_id", "code": 407 }
{ "err": true, "message": "Invalid schedule date\/time", "code": 136 }