Unsubscribe API - Unsubscribe Members from Email Campaigns

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000102546-unsubscribe-api-unsubscribe-members-from-email-campaigns

It is possible to Unsubscribe a member from receiving email using the api, only 1 member can be updated at a time.


Using the API there are 4 Unsubscribe actions that can be achieved:

  1. /api/v2/unsubscribe_list/get/{id}
  2. /api/v2/unsubscribe_list/create
  3. /api/v2/unsubscribe_list/update
  4. /api/v2/unsubscribe_list/delete


We will break down these actions and explain how to achieve an end results with each one. The examples shown in this article are completed using https://www.postman.com/


Unsubscribe Get API


/api/v2/unsubscribe_list/get/{id}


Using this action is simple, add the url above but replace {id} with the actual member ID. This will fetch the member information from the website



Unsubscribe Create API


/api/v2/unsubscribe_list/create


With this action, by sending the email, it will add the member to the unsubscribe list.




Unsubscribe Update API


/api/v2/unsubscribe_list/update


With this action it is possible to update the unsubscribed list. Replace {id} with the member ID that will be updated from the unsubscribed list.


Unsubscribe Delete API


/api/v2/unsubscribe_list/delete


Use this action URL to delete a a member from the unsubscribed list, replace {id} with the member ID that will be removed from the unsubscribed list.