All URIs are relative to https://api.mailmojo.no
| Method | HTTP request | Description |
|---|---|---|
| formAddSubscriber | PATCH /v1/forms/{id}/subscribers/ | Add a subscriber through a form and track the conversion. |
| getFormById | GET /v1/forms/{id}/ | Retrieve a form. |
| getForms | GET /v1/forms/ | Retrieve all forms. |
| trackFormView | PATCH /v1/forms/{id}/track/view/ | Track a view of a form. |
| updateForm | PATCH /v1/forms/{id}/ | Update a form partially. |
\MailMojo\MailMojo\Model\FormConversion formAddSubscriber($id, $subscriber)
Add a subscriber through a form and track the conversion.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: mailmojo_auth
$config = MailMojo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new MailMojo\Api\FormApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID of the form.
$subscriber = new \MailMojo\MailMojo\Model\AddFormSubscriber(); // \MailMojo\MailMojo\Model\AddFormSubscriber |
try {
$result = $apiInstance->formAddSubscriber($id, $subscriber);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FormApi->formAddSubscriber: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of the form. | |
| subscriber | \MailMojo\MailMojo\Model\AddFormSubscriber |
\MailMojo\MailMojo\Model\FormConversion
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\MailMojo\MailMojo\Model\Form getFormById($id)
Retrieve a form.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: mailmojo_auth
$config = MailMojo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new MailMojo\Api\FormApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID of the form to retrieve.
try {
$result = $apiInstance->getFormById($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FormApi->getFormById: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of the form to retrieve. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\MailMojo\MailMojo\Model\Form[] getForms($is_published)
Retrieve all forms.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: mailmojo_auth
$config = MailMojo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new MailMojo\Api\FormApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$is_published = false; // bool | List only published forms.
try {
$result = $apiInstance->getForms($is_published);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FormApi->getForms: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| is_published | bool | List only published forms. | [optional] [default to false] |
\MailMojo\MailMojo\Model\Form[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\MailMojo\MailMojo\Model\TrackFormView trackFormView($id, $view)
Track a view of a form.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: mailmojo_auth
$config = MailMojo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new MailMojo\Api\FormApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID of the form to track view of.
$view = new \MailMojo\MailMojo\Model\TrackFormView(); // \MailMojo\MailMojo\Model\TrackFormView |
try {
$result = $apiInstance->trackFormView($id, $view);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FormApi->trackFormView: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of the form to track view of. | |
| view | \MailMojo\MailMojo\Model\TrackFormView |
\MailMojo\MailMojo\Model\TrackFormView
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\MailMojo\MailMojo\Model\Form updateForm($id, $form)
Update a form partially.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: mailmojo_auth
$config = MailMojo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new MailMojo\Api\FormApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 56; // int | ID of the form to update.
$form = new \MailMojo\MailMojo\Model\Form(); // \MailMojo\MailMojo\Model\Form |
try {
$result = $apiInstance->updateForm($id, $form);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FormApi->updateForm: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of the form to update. | |
| form | \MailMojo\MailMojo\Model\Form | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]