NewsMAN API: newsletter.statusactions

Sections

Newsman – Knowledge Base

HomeAPINewsletternewsletter.statusactions

Newsman Api Method: newsletter.statusactions

Prototype: newsletter.statusactions(newsletter_id)

Description: Returns info about the newsletter status and actions which may be taken

HTTP method: GET

Endpoint HTTP: /newsletter.statusactions.json

Endpoint XML-RPC: newsletter.statusactions

Return type: struct

Return info: Array containing the status info of the newsletter. Array with status and actions available.

Request parameters GET

Variable	Type	Description
newsletter_id	string\|int	The ID of the newsletter for which to get the status

Response parameters

Parameter	Description
array	Array containing the status info of the newsletter. Array with status and actions available.

Output example

[
    {
        "status": "0",
        "status_description": "unconfirmed",
        "actions": [
            "confirm",
            "schedule",
            "cancel"
        ]
    }
]

Response 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

Error examples

{
    "err": true,
    "message": "Missing required param newsletter_id",
    "code": 407
}

{
    "err": true,
    "message": "No such newsletter with ID: 99554.",
    "code": 131
}