« Back to Documentation Overview

set_contact_cycle

Section: Contacts
Version: 1.5.0


Place a contact on a desired day of the autoresponder cycle or deactivate a contact.
Conditions:

  • contact (mandatory) – CONTACT_ID obtained from get_contacts.
  • cycle_day (mandatory) – Insert contact on a given day at the autoresponder cycle. Value of 0 means the beginning of the cycle. Setting value to null means that a contact will not be inserted into cycle.


Parameters
stringAPI_KEY
object
stringcontactCONTACT_ID
integercycle_day4
Return Value
integerupdated1

Example Request JSON

[
    "API_KEY",
    {
        "contact": "CONTACT_ID",
        "cycle_day": 4
    }
]

Example Response JSON

{
    "updated": 1
}

Example Error Response JSON

{
    "code": -1,
    "message": "Missing Contact"
}
Method-specific Errors
Missing Contact
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