add_mailinglist() | API Reference

Signature

add_mailinglist(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name	Description	Requirement
`mailinglist_name`	The list name	Required
`mailinglist_domain`	The domain name of the list	Required
`mailinglist_password`	The list password	Required

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'mailinglist_name' => 'my_mailinglist',
    'mailinglist_domain' => 'example.com',
    'mailinglist_password' => 'my_password',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'add_mailinglist',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}

Open interactive example

Responses and error codes

TRUE the action was carried out
missing_parameter a required parameter is missing
couldnt_get_kas_ressources
mailinglist_already_exists
mailinglist_domain_doesnt_exist
mailinglist_domain_syntax_incorrect
mailinglist_syntax_incorrect
max_mailinglists_reached
password_syntax_incorrect