Skip to content

LeadSourceCategoriesApi.md

Latest commit

 

History

History
316 lines (218 loc) · 11.4 KB

LeadSourceCategoriesApi.md

File metadata and controls

316 lines (218 loc) · 11.4 KB

Keap\Core\V2\LeadSourceCategoriesApi

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

Method HTTP request Description
createLeadSourceCategory() POST /rest/v2/leadSourceCategories Create a Lead Source Category
deleteLeadSourceCategory() DELETE /rest/v2/leadSourceCategories/{lead_source_category_id} Delete a Lead Source Category
getLeadSourceCategory() GET /rest/v2/leadSourceCategories/{lead_source_category_id} Retrieve a Lead Source Category
listLeadSourceCategories() GET /rest/v2/leadSourceCategories List Lead Source Categories
updateLeadSourceCategory() PATCH /rest/v2/leadSourceCategories/{lead_source_category_id} Update a Lead Source Category

createLeadSourceCategory()

createLeadSourceCategory($create_update_lead_source_category_request): \Keap\Core\V2\Model\LeadSourceCategory

Create a Lead Source Category

Creates a new Lead Source Category.

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\LeadSourceCategoriesApi(
    // 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
);
$create_update_lead_source_category_request = new \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest(); // \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest

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

Parameters

Name Type Description Notes
create_update_lead_source_category_request \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest

Return type

\Keap\Core\V2\Model\LeadSourceCategory

Authorization

oauth2

HTTP request headers

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

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

deleteLeadSourceCategory()

deleteLeadSourceCategory($lead_source_category_id)

Delete a Lead Source Category

Deletes the specified Lead Source Category

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\LeadSourceCategoriesApi(
    // 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
);
$lead_source_category_id = 'lead_source_category_id_example'; // string | The ID of a lead source category

try {
    $apiInstance->deleteLeadSourceCategory($lead_source_category_id);
} catch (Exception $e) {
    echo 'Exception when calling LeadSourceCategoriesApi->deleteLeadSourceCategory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
lead_source_category_id string The ID of a lead source category

Return type

void (empty response body)

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]

getLeadSourceCategory()

getLeadSourceCategory($lead_source_category_id): \Keap\Core\V2\Model\LeadSourceCategory

Retrieve a Lead Source Category

Retrieves a single Lead Source Category for a given ID

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\LeadSourceCategoriesApi(
    // 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
);
$lead_source_category_id = 'lead_source_category_id_example'; // string | The ID of a lead source category

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

Parameters

Name Type Description Notes
lead_source_category_id string The ID of a lead source category

Return type

\Keap\Core\V2\Model\LeadSourceCategory

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]

listLeadSourceCategories()

listLeadSourceCategories($filter, $order_by, $page_size, $page_token): \Keap\Core\V2\Model\ListLeadSourceCategoriesResponse

List Lead Source Categories

Retrieves a list of Lead Source Categories

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\LeadSourceCategoriesApi(
    // 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
);
$filter = 'filter_example'; // string | Filter to apply, allowed fields are:  - (String) `name`  You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here is an example:  - `filter=name%3D%3Dexample`
$order_by = 'order_by_example'; // string | Attribute and direction to order items. One of the following fields: - `name`  One of the following directions: - `asc` - `desc`
$page_size = 0; // int | Total number of items to return per page
$page_token = 'page_token_example'; // string | Page token

try {
    $result = $apiInstance->listLeadSourceCategories($filter, $order_by, $page_size, $page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadSourceCategoriesApi->listLeadSourceCategories: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
filter string Filter to apply, allowed fields are: - (String) `name` You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here is an example: - `filter=name%3D%3Dexample` [optional]
order_by string Attribute and direction to order items. One of the following fields: - `name` One of the following directions: - `asc` - `desc` [optional]
page_size int Total number of items to return per page [optional]
page_token string Page token [optional]

Return type

\Keap\Core\V2\Model\ListLeadSourceCategoriesResponse

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]

updateLeadSourceCategory()

updateLeadSourceCategory($lead_source_category_id, $create_update_lead_source_category_request, $update_mask): \Keap\Core\V2\Model\LeadSourceCategory

Update a Lead Source Category

Updates a Lead Source Category

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\LeadSourceCategoriesApi(
    // 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
);
$lead_source_category_id = 'lead_source_category_id_example'; // string | The ID of a lead source category
$create_update_lead_source_category_request = new \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest(); // \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest
$update_mask = NULL; // mixed | An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.

try {
    $result = $apiInstance->updateLeadSourceCategory($lead_source_category_id, $create_update_lead_source_category_request, $update_mask);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadSourceCategoriesApi->updateLeadSourceCategory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
lead_source_category_id string The ID of a lead source category
create_update_lead_source_category_request \Keap\Core\V2\Model\CreateUpdateLeadSourceCategoryRequest
update_mask mixed An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped. [optional]

Return type

\Keap\Core\V2\Model\LeadSourceCategory

Authorization

oauth2

HTTP request headers

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

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