NewsMAN API: subscriber.getSubscribersBatch

Sections

KB Newsman

HomeAPISubscribersubscriber.getSubscribersBatch

Newsman Api Method: subscriber.getSubscribersBatch

Prototype: subscriber.getSubscribersBatch(list_id, subscribers)

Description: Retrieves multiple subscribers by email or subscriber_id

HTTP method: GET

Endpoint HTTP: /subscriber.getSubscribersBatch.json

Endpoint XML-RPC: subscriber.getSubscribersBatch

Return type: Array

Return info: conținând informațiile abonaților găsiți

Request parameters GET

Variable	Type	Description
list_id	string\|int	The ID of the list to which belong the subscribers whose props are to be updated
subscribers	struct	Array containing emails or subscriber ids

Response parameters

Parameter	Description
boolean	Array containing data for the found subscribers

Output example

[
    {
        "list_id": "my_list_id",
        "subscriber_id": 75001,
        "email": "john.doe@example.com",
        "status": "subscribed",
        "subscription_type": "import",
        "subscribe_date": "2018-05-13 17:02:32",
        "firstname": null,
        "lastname": null,
        "ip": "127.0.0.1",
        "props": [],
        "segments": [
            {
                "segment_id": 15002,
                "name": "my_segment_name"
            }
        ]
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param subscribers	subscribers param is required
101	Not allowed for list_id = %s	Invalid access to subscriber list_id
129	Not allowed for subscriber with ID: %s	Invalid access to subscriber ID
108	List %s has been deleted	List ID belongs to a list which has been deleted

Error examples

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

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

{
    "err": true,
    "message": "Not allowed for subscriber with ID: 427001",
    "code": 129
}