KB Newsman
Newsman Api Method: newsletter.setAlternateContent
Prototype: newsletter.setAlternateContent(newsletter_id, akey, content)
Description: Sets the alternate content for a newsletter (viewable online at ##NEWSMAN:view_online##?akey=)
HTTP method: GET
Endpoint HTTP: /newsletter.setAlternateContent.json
Endpoint XML-RPC: newsletter.setAlternateContent
Return type: booleanReturn info: True if update was ok, false otherwise
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| newsletter_id | string|int | The ID of the newsletter for which to update the segments |
| akey | string | The alternate key |
| content | string | The html content |
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 |
| 407 | Missing required param akey | akey param is required |
| 407 | Missing required param content | content param is required |
| 131 | No such newsletter with ID: %s. | Invalid access to newsletter_id |
| 1312 | Newsletter %s can't set content. | Cannot set alternate content for this newsletter |
Error examples
{ "err": true, "message": "Missing required param newsletter_id", "code": 407 }