SettingsApi.md

Keap\Core\V2\SettingsApi

All URIs are relative to https://api.keap.com/crm, except if the operation defines another base path.

Method	HTTP request	Description
getApplicationConfigurations()	GET /rest/v2/settings/applications:getConfiguration	Get Application Configuration
getContactOptionTypes()	GET /rest/v2/settings/contactOptionTypes	Get Contact Option types
isApplicationEnabled()	GET /rest/v2/settings/applications:isEnabled	Get Application Status

getApplicationConfigurations()

getApplicationConfigurations($fields): \Keap\Core\V2\Model\GetSettingsResponse

Get Application Configuration

Get configuration values for the application instance.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Keap\Core\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Keap\Core\V2\Api\SettingsApi(
    // 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
);
$fields = array('fields_example'); // string[] | By default, only application data is returned. In addition to that, data is returned for the fields that are mentioned in the query.

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

Parameters

Name	Type	Description	Notes
fields	string[]	By default, only application data is returned. In addition to that, data is returned for the fields that are mentioned in the query.	[optional]

Return type

\Keap\Core\V2\Model\GetSettingsResponse

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getContactOptionTypes()

getContactOptionTypes(): \Keap\Core\V2\Model\GetContactOptionTypesResponse

Get Contact Option types

Gets a list of Contact Option types.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Keap\Core\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Keap\Core\V2\Api\SettingsApi(
    // 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->getContactOptionTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getContactOptionTypes: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Keap\Core\V2\Model\GetContactOptionTypesResponse

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

isApplicationEnabled()

isApplicationEnabled(): \Keap\Core\V2\Model\GetApplicationEnabledStatusResponse

Get Application Status

Check if the application is enabled or not

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Keap\Core\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Keap\Core\V2\Api\SettingsApi(
    // 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->isApplicationEnabled();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->isApplicationEnabled: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Keap\Core\V2\Model\GetApplicationEnabledStatusResponse

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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