NewsMAN API: list.getSubscriberVariables

Sections

Newsman – Knowledge Base

HomeAPIListlist.getSubscriberVariables

Newsman Api Method: list.getSubscriberVariables

Prototype: list.getSubscriberVariables(list_id)

Description: Returns the custom variables for the subscribers of a list.

HTTP method: GET

Endpoint HTTP: /list.getSubscriberVariables.json

Endpoint XML-RPC: list.getSubscriberVariables

Return type: struct

Return info: Hash array

Request parameters GET

Variable	Type	Description
list_id	string\|int	The ID of the list for which to get the variables

Response parameters

Parameter	Description
name	The name of the variable
type	The type of the variable

Output example

[
    {
        "name": "my_field_1",
        "type": "Date"
    },
    {
        "name": "my_field_2",
        "type": "String"
    },
    {
        "name": "my_field_3",
        "type": "String"
    },
    {
        "name": "my_field_4",
        "type": "Number"
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
101	Not allowed for list_id = %s	Invalid access to list_id

Error examples

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