MailMojo\ListApi

All URIs are relative to https://api.mailmojo.no

Method	HTTP request	Description
createList	POST /v1/lists/	Create an email list.
createSegment	POST /v1/lists/{list_id}/segments/	Create a segment in the email list.
getListById	GET /v1/lists/{list_id}/	Retrieve an email list.
getLists	GET /v1/lists/	Retrieve all email lists.
getSubscriberOnListByEmail	GET /v1/lists/{list_id}/subscribers/{email}/	Retrieve a subscriber.
getSubscribersOnList	GET /v1/lists/{list_id}/subscribers/	Retrieve subscribers on a list.
getUnsubscribedOnList	GET /v1/lists/{list_id}/unsubscribed/	Retrieve unsubscribed contacts on a list.
importSubscribersToList	POST /v1/lists/{list_id}/subscribers/import/	Subscribe contacts to the email list.
subscribeContactToList	POST /v1/lists/{list_id}/subscribers/	Subscribe a contact to the email list.
unsubscribeContactOnListByEmail	DELETE /v1/lists/{list_id}/subscribers/{email}/	Unsubscribe a contact.
updateList	PATCH /v1/lists/{list_id}/	Update an email list partially.

createList

\MailMojo\MailMojo\Model\ModelList createList($list)

Create an email list.

Example

<?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\ListApi(
    // 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
);
$list = new \MailMojo\MailMojo\Model\ModelList(); // \MailMojo\MailMojo\Model\ModelList | 

try {
    $result = $apiInstance->createList($list);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->createList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list	\MailMojo\MailMojo\Model\ModelList

Return type

\MailMojo\MailMojo\Model\ModelList

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createSegment

\MailMojo\MailMojo\Model\Segment createSegment($list_id, $segment)

Create a segment in the email list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to create a segment in.
$segment = new \MailMojo\MailMojo\Model\SegmentCreation(); // \MailMojo\MailMojo\Model\SegmentCreation | 

try {
    $result = $apiInstance->createSegment($list_id, $segment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->createSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to create a segment in.
segment	\MailMojo\MailMojo\Model\SegmentCreation

Return type

\MailMojo\MailMojo\Model\Segment

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getListById

\MailMojo\MailMojo\Model\ListDetail getListById($list_id)

Retrieve an email list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to retrieve.

try {
    $result = $apiInstance->getListById($list_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getListById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to retrieve.

Return type

\MailMojo\MailMojo\Model\ListDetail

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLists

\MailMojo\MailMojo\Model\ModelList[] getLists()

Retrieve all email lists.

Example

<?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\ListApi(
    // 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
);

try {
    $result = $apiInstance->getLists();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getLists: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\MailMojo\MailMojo\Model\ModelList[]

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubscriberOnListByEmail

\MailMojo\MailMojo\Model\Subscriber getSubscriberOnListByEmail($list_id, $email)

Retrieve a subscriber.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to retrieve the subscriber from.
$email = "email_example"; // string | Email address of the contact to retrieve.

try {
    $result = $apiInstance->getSubscriberOnListByEmail($list_id, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getSubscriberOnListByEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to retrieve the subscriber from.
email	string	Email address of the contact to retrieve.

Return type

\MailMojo\MailMojo\Model\Subscriber

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubscribersOnList

\MailMojo\MailMojo\Model\Subscriber[] getSubscribersOnList($list_id, $limit)

Retrieve subscribers on a list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list.
$limit = 56; // int | Limits the result to given count.

try {
    $result = $apiInstance->getSubscribersOnList($list_id, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getSubscribersOnList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list.
limit	int	Limits the result to given count.	[optional]

Return type

\MailMojo\MailMojo\Model\Subscriber[]

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUnsubscribedOnList

\MailMojo\MailMojo\Model\Contact[] getUnsubscribedOnList($list_id, $limit)

Retrieve unsubscribed contacts on a list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list.
$limit = 56; // int | Limits the result to given count.

try {
    $result = $apiInstance->getUnsubscribedOnList($list_id, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getUnsubscribedOnList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list.
limit	int	Limits the result to given count.	[optional]

Return type

\MailMojo\MailMojo\Model\Contact[]

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

importSubscribersToList

\MailMojo\MailMojo\Model\ImportResult importSubscribersToList($list_id, $contacts)

Subscribe contacts to the email list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to subscribe to.
$contacts = "contacts_example"; // string | 

try {
    $result = $apiInstance->importSubscribersToList($list_id, $contacts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->importSubscribersToList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to subscribe to.
contacts	string

Return type

\MailMojo\MailMojo\Model\ImportResult

Authorization

mailmojo_auth

HTTP request headers

Content-Type: text/csv
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

subscribeContactToList

\MailMojo\MailMojo\Model\Contact subscribeContactToList($list_id, $contact)

Subscribe a contact to the email list.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to subscribe to.
$contact = new \MailMojo\MailMojo\Model\Subscriber(); // \MailMojo\MailMojo\Model\Subscriber | 

try {
    $result = $apiInstance->subscribeContactToList($list_id, $contact);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->subscribeContactToList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to subscribe to.
contact	\MailMojo\MailMojo\Model\Subscriber

Return type

\MailMojo\MailMojo\Model\Contact

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unsubscribeContactOnListByEmail

\MailMojo\MailMojo\Model\Contact unsubscribeContactOnListByEmail($list_id, $email)

Unsubscribe a contact.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to unsubscribe from.
$email = "email_example"; // string | Email address of the contact to unsubscribe.

try {
    $result = $apiInstance->unsubscribeContactOnListByEmail($list_id, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->unsubscribeContactOnListByEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to unsubscribe from.
email	string	Email address of the contact to unsubscribe.

Return type

\MailMojo\MailMojo\Model\Contact

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateList

\MailMojo\MailMojo\Model\ListDetail updateList($list_id, $list)

Update an email list partially.

Example

<?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\ListApi(
    // 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
);
$list_id = 56; // int | ID of the email list to retrieve.
$list = new \MailMojo\MailMojo\Model\ListDetail(); // \MailMojo\MailMojo\Model\ListDetail | 

try {
    $result = $apiInstance->updateList($list_id, $list);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->updateList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
list_id	int	ID of the email list to retrieve.
list	\MailMojo\MailMojo\Model\ListDetail		[optional]

Return type

\MailMojo\MailMojo\Model\ListDetail

Authorization

mailmojo_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ListApi.md

Latest commit

History

ListApi.md

File metadata and controls

MailMojo\ListApi

createList

Example

Parameters

Return type

Authorization

HTTP request headers

createSegment

Example

Parameters

Return type

Authorization

HTTP request headers

getListById

Example

Parameters

Return type

Authorization

HTTP request headers

getLists

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscriberOnListByEmail

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscribersOnList

Example

Parameters

Return type

Authorization

HTTP request headers

getUnsubscribedOnList

Example

Parameters

Return type

Authorization

HTTP request headers

importSubscribersToList

Example

Parameters

Return type

Authorization

HTTP request headers

subscribeContactToList

Example

Parameters

Return type

Authorization

HTTP request headers

unsubscribeContactOnListByEmail

Example

Parameters

Return type

Authorization

HTTP request headers

updateList

Example

Parameters

Return type

Authorization

HTTP request headers