« Back to Documentation Overview

get_segments

Section: Contacts
Version: 1.5.0


Get contact segments saved on web interface to use in send_newsletter.


Parameters
stringAPI_KEY
object
objectname
stringOPERATORvalue
Return Value
objectSEGMENT_ID
stringnameKids
stringcreated_on2012-04-13 00:00:00

Example Request JSON

[
    "API_KEY",
    {
        "name": {
            "OPERATOR": "value"
        }
    }
]

Example Response JSON

{
    "SEGMENT_ID": {
        "name": "Kids",
        "created_on": "2012-04-13 00:00:00"
    }
}
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