« Back to Documentation Overview

set_autoresponder_cycle

Section: Messages
Version: 1.5.0


Set day of cycle of existing time based autoresponder.
Warning: This method can be used on time based autoresponders only, get_messages provides based_on field to distinguish time and action based autoresponders.


Parameters
stringAPI_KEY
object
stringmessageMESSAGE_ID
integerday_of_cycle64
Return Value
integerupdated1

Example Request JSON

[
    "API_KEY",
    {
        "message": "MESSAGE_ID",
        "day_of_cycle": 64
    }
]

Example Response JSON

{
    "updated": 1
}

Example Error Response JSON

{
    "code": -1,
    "message": "Message is not time based"
}
Method-specific Errors
Missing message
Message is not time based
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash