Gigabark Application Programming Interface (API)

recipient_list_unsubscribe

Description:   Remove a recipient telephone number from the given recipient list.
NOTE: This API should not be used to bulk-remove a large number of recipients. More efficient methods can be provided by contacting support@gigabark.com
URL:   https://www.gigabark.com/api/recipient_list_unsubscribe.php
Returns:    [recipient_list object] or [error object]

Parameters

Parameter Name	Required	Description	Permitted Valued	Default
email	Yes	The email address associated with the Gigabark account making API requests		(none)
password	Yes	The password used to log into the Gigabark account making API requests		(none)
format	No	The format of responses from the Gigabark servers to your API requests.	xml, json	xml
recipient_list_id	Yes	The recipient list ID from which to remove recipient.		(none)
recipient_telephone	Yes	The telephone number of the recipient to remove		(none)

Interactive API Test Tool

This tool simulates an API call to our system at the URL above. The data in the form fields are the parameters sent in that API call. The response from our system is shown below.

email *
password *
format
recipient_list_id *
recipient_telephone *

Since you are not logged in, we return an empty object and avoid login verification.

Parameter string on API call:

Response to API call:

Sample PHP Code to call API:

$curl_url = "https://gigabark.com/api/recipient_list_unsubscribe.php";
$POST = "email=your.email@email.com&password=pwd"; // Add params from this page

$curl_handle=curl_init($curl_url);
if (!$curl_handle) die("curl connection failed");

curl_setopt($curl_handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl_handle, CURLOPT_POST,1);
curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER,1);
curl_setopt($curl_handle, CURLOPT_TIMEOUT, 5);
curl_setopt($curl_handle, CURLOPT_POSTFIELDS,$POST);

$output = curl_exec($curl_handle);
curl_close($curl_handle);