Autoresponders
Get All Autoresponders
GET https://api.expresspigeon.com/auto_responders
Returns an array of autoresponders.
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/auto_responders'
|
1
2
3
4
5
6
7
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toList;
String response = Http.get("https://api.expresspigeon.com/auto_responders")
.header("X-auth-key", AUTH_KEY)
.text();
List result = toList(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.all
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
auto_responders = api.auto_responders.find_all()
|
Example Response
1
2
3
4
5
6
7
8
9
| [{
"auto_responder_parts": [{
"auto_responder_part_id": 1,
"subject": "My autoresponder",
"template_id": 1
}],
"name": "My autoresponder",
"auto_responder_id": 1
}]
|
POST https://api.expresspigeon.com/auto_responders/{auto_responder_id}/start
This call starts an autoresponder for a contact.
Request Parameters
| auto_responder_id |
Yes |
Autoresponder id to be started for a contact |
| email |
Yes |
Contact email |
Example Request
1
2
3
4
| curl -X POST -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
-H "Content-type: application/json" \
-d '{"email": "bob@example.net"}' \
'https://api.expresspigeon.com/auto_responders/1/start'
|
1
2
3
4
5
6
7
8
9
10
11
| import org.javalite.http.Http;
import static org.javalite.common.Collections.map;
import static org.javalite.common.JsonHelper.toJsonString;
import static org.javalite.common.JsonHelper.toMap;
String content = toJsonString(map("email", "bob@example.net"));
String response = Http.post("https://api.expresspigeon.com/auto_responders/1/start", content)
.header("X-auth-key", AUTH_KEY)
.header("Content-type", "application/json")
.text();
Map<String, Object> result = toMap(response);
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| $data = array(
'email' => 'bob@example.net'
);
$options = array(
'http' => array(
'method' => 'POST',
'content' => json_encode($data),
'header' => "Content-Type: application/json\r\n" .
"X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1/start', false, $context);
$response = json_decode($result);
|
1
2
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.start responder_id, 'john@example.com'
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.start(1, "bob@example.net")
|
Example Response
1
2
3
4
5
| {
"status": "success",
"code": 200,
"message": "auto_responder=1 started successfully for contact=bob@example.net"
}
|
POST https://api.expresspigeon.com/auto_responders/{auto_responder_id}/stop
This call stops an autoresponder for a contact.
Request Parameters
| auto_responder_id |
Yes |
Autoresponder id to be stopped for a contact |
| email |
Yes |
Contact email |
Example Request
1
2
3
4
| curl -X POST -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
-H "Content-type: application/json" \
-d '{"email": "bob@example.net"}' \
'https://api.expresspigeon.com/auto_responders/1/stop'
|
1
2
3
4
5
6
7
8
9
10
11
| import org.javalite.http.Http;
import static org.javalite.common.Collections.map;
import static org.javalite.common.JsonHelper.toJsonString;
import static org.javalite.common.JsonHelper.toMap;
String content = toJsonString(map("email", "bob@example.net"));
String response = Http.post("https://api.expresspigeon.com/auto_responders/1/stop", content)
.header("X-auth-key", AUTH_KEY)
.header("Content-type", "application/json")
.text();
Map<String, Object> result = toMap(response);
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| $data = array(
'email' => 'bob@example.net'
);
$options = array(
'http' => array(
'method' => 'POST',
'content' => json_encode($data),
'header' => "Content-Type: application/json\r\n" .
"X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1/stop', false, $context);
$response = json_decode($result);
|
1
2
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.stop responder_id, 'john@example.com'
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.stop(1, "bob@example.net")
|
Example Response
1
2
3
4
5
| {
"status": "success",
"code": 200,
"message": "auto_responder=1 stopped successfully for contact=bob@example.net"
}
|
Report for a Single Autoresponder
GET https://api.expresspigeon.com/auto_responders/{auto_responder_id}
Returns a report for a single autoresponder by id.
Request parameters
| auto_responder_id |
Yes |
Autoresponder id for which this report is generated |
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/auto_responders/1'
|
1
2
3
4
5
6
7
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toList;
String response = Http.get("https://api.expresspigeon.com/auto_responders/1")
.header("X-auth-key", AUTH_KEY)
.text();
List result = toList(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.report responder_id
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.report(1)
|
Example Response
1
2
3
4
5
6
7
8
9
10
| [{
"auto_responder_part_id": 9,
"delivered": 1,
"unsubscribed": 0,
"in_transit": 0,
"bounced": 0,
"spam": 0,
"clicked": 0,
"opened": 1
}]
|
GET https://api.expresspigeon.com/auto_responders/ {auto_responder_id}/{auto_responder_part_id}/bounced
Returns an array of object(s) with email and id of bounced contacts associated with this autoresponder part.
Request parameters
| auto_responder_id |
Yes |
Autoresponder id the bounced contacts are found for |
| auto_responder_part_id |
Yes |
Autoresponder part id the bounced contacts are found for |
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/auto_responders/1/2/bounced'
|
1
2
3
4
5
6
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toList;
String response = Http.get("https://api.expresspigeon.com/auto_responders/1/2/bounced")
.header("X-auth-key", AUTH_KEY).text();
List result = toList(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1/2/bounced', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.bounced responder_id, responder_part_id
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.bounced(1, 2)
|
Example Response
1
| [{"id": 1, "email": "bob@example.net"}, {"id": 2, "email": "tob@example.net"}]
|
GET https://api.expresspigeon.com/auto_responders/ {auto_responder_id}/{auto_responder_part_id}/unsubscribed
Returns an array of object(s) with email and id of unsubscribed contacts associate with this autoresponder part.
Request Parameters
| auto_responder_id |
Yes |
Autoresponder id the unsubscribed contacts are found for |
| auto_responder_part_id |
Yes |
Autoresponder part id the unsubscribed contacts are found for |
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/auto_responders/1/2/unsubscribed'
|
1
2
3
4
5
6
7
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toList;
String response = Http.get("https://api.expresspigeon.com/auto_responders/1/2/unsubscribed")
.header("X-auth-key", AUTH_KEY)
.text();
List result = toList(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1/2/unsubscribed', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.unsubscribed responder_id, responder_part_id
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.unsubscribed(1, 2)
|
Example Response
1
| [{"id": 1, "email": "bob@example.net"}, {"id": 2, "email": "tob@example.net"}]
|
GET https://api.expresspigeon.com/auto_responders/ {auto_responder_id}/{auto_responder_part_id}/spam
Returns an array of object(s) with email and id of spam contacts associated with this autoresponder part.
Request Parameters
| auto_responder_id |
Yes |
Autoresponder id the spam contacts are found for |
| auto_responder_part_id |
Yes |
Autoresponder part id the spam contacts are found for |
Example Request
1
2
| curl -H "X-auth-key: 00000000-0000-0000-0000-000000000000" \
'https://api.expresspigeon.com/auto_responders/1/2/spam'
|
1
2
3
4
5
6
7
| import org.javalite.http.Http;
import static org.javalite.common.JsonHelper.toList;
String response = Http.get("https://api.expresspigeon.com/auto_responders/1/2/spam")
.header("X-auth-key", AUTH_KEY)
.text();
List result = toList(response);
|
1
2
3
4
5
6
7
8
9
| $options = array(
'http' => array(
'method' => 'GET',
'header' => "X-auth-key: 00000000-0000-0000-0000-000000000000\r\n"
)
);
$context = stream_context_create($options);
$result = file_get_contents('https://api.expresspigeon.com/auto_responders/1/2/spam', false, $context);
$response = json_decode($result);
|
1
2
3
| require 'expresspigeon-ruby'
res = ExpressPigeon::API.autoresponders.spam responder_id, responder_part_id
|
1
2
3
4
| from expresspigeon import ExpressPigeon
api = ExpressPigeon()
response = api.auto_responders.spam(1, 2)
|
Example Response
1
| [{"id": 1, "email": "bob@example.net"}, {"id": 2, "email": "tob@example.net"}]
|