API to check if a person has unsubscribed from a list

[SoftTimur]

Hello,

I have a big list, thus downloading all of its unsubscribers is very time-consuming by this method: https://forum.mailwizz.com/threads/download-all-the-unsubscribers-of-a-list.9068/#post-54012.

I do need to check if a person has unsubscribed from a list, does anyone know if there is any API to do so?

Thank you

Timur

 

[laurentiu]

I do need to check if a person has unsubscribed from a list, does anyone know if there is any API to do so?

Check this: https://api-docs.mailwizz.com/#get-unsubscribed-subscribers also you have other endpoint: https://api-docs.mailwizz.com/#search-by-status

 

[SoftTimur]

Check this: https://api-docs.mailwizz.com/#get-unsubscribed-subscribers also you have other endpoint: https://api-docs.mailwizz.com/#search-by-status

I would like to use node.

I tried the following code:

const { ListSubscribers } = require('node-mailwizz');


const config = {
    publicKey: '___',
    secret: '___',
    baseUrl: 'http://mail.mycompany.com/api'
}
// Configuration details directly in the class constructor
const subscribers = new ListSubscribers(config);


// Function to search for a subscriber by email
function searchSubscriber(listUid, email) {
    console.log("listUid", listUid)
    console.log("email", email)
    subscribers.emailSearch({
        listUid: listUid,
        email: email
    })
    .then(result => {
        console.log('Subscriber found:', result);
    })
    .catch(err => {
        console.error('Error:', err);
    });
}


// Example usage of the function
searchSubscriber('en804x0lnrf1f', 'fabio.ginnetti@savoiaesavoia.it');

However, it returned

listUid en804x0lnrf1f
email fabio.ginnetti@savoiaesavoia.it
Error: {
  status: 'error',
  error: 'Please provide the subscriber email address.'
}

 

[laurentiu]

I would like to use node.

I tried the following code:

This is not our library and we cannot manage what it's happens, so if you want to use API please use the php sdk which is the most updated and it's working.

 

[twisted1919]

@SoftTimur - I see they document it at https://github.com/MikelCalvo/node-mailwizz so maybe ask them there. As @laurentiu said, this is not our library so not sure how to help.

 

[twisted1919]

I think i know:

Your call:

subscribers.emailSearch({ listUid: listUid, email: email })

Does not look correct, I think it should be:

subscribers.emailSearch({ listUid: listUid, subscriberEmail: email })

Because emailSearch receives a param of type EmailSearchParams which is defined at https://github.com/MikelCalvo/node-...57c0df92180/src/types/ListSubscribers.ts#L131 and it requires the key to be subscriberEmail not email.

 

[SoftTimur]

I think i know:

Your call:

Does not look correct, I think it should be:

subscribers.emailSearch({ listUid: listUid, subscriberEmail: email })

Because emailSearch receives a param of type EmailSearchParams which is defined at https://github.com/MikelCalvo/node-...57c0df92180/src/types/ListSubscribers.ts#L131 and it requires the key to be subscriberEmail not email.

It works, thank you.