Use the API call to retrieve specific contact details from the list.
Required Parameters to Submit Request
- API Token- Token that you have generated using generate API token. Make sure you are using the most recent one.
- End Point- End point for the Add List API would appear http://my.mumara.com/api/getSubscriber . It represents your instance of CampaignsPlus, along with the function name you are requesting through API
Method (GET)
Required to Get Contact
subscriber_id |
Go to view/search contacts page, and find the subscriber id of particular contact that you would need to get information of. See in the following sample request how the subscriber id is used in the API request. |
Sample Request
<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL,"http://my.mumara.host/api/getSubscriber?api_token=xxxxxxxxxxxxxxxxxx&subscriber_id=5"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $output = curl_exec ($ch); print_r($output); curl_close ($ch); ?>
Success Response
Upon submitting a successful API request, you will be returned contact information like email, information stored within additional fields, confirmation status, unsubscribe, unsubscribe date, bounced, bounce date and such related information.
Note: This function wouldn't retrieve information from the custom fields, for that you would need to use another function.
{"status":"success","response":"Subscriber Data"}
Error Response
{"status":"error","response":"subscriber id not found"}
Comments
0 comments
Please sign in to leave a comment.
Article Path: /hc/en-us/articles/360002116891-Get-Subscriber-Contact-API-
Article Title: Get Subscriber/Contact- API