LeadsApi.md

Ageras\Api\LeadsApi

All URIs are relative to https://api.ageras.com/v2

Method	HTTP request	Description
leadsActionsCreate	POST /leads/{lead_id}/actions	This function serves up one class with a lot of functionality
leadsAggregationsIndex	GET /leads/aggregations
leadsAllocationsCreate	POST /leads/{lead_id}/allocations
leadsAllocationsIndex	GET /leads/allocations
leadsAllocationsuggestionsDelete	DELETE /leads/{lead_id}/allocationsuggestions/{allocation_suggestion_id}
leadsCategoriesIndex	GET /leads/categories
leadsCertificationsCreate	POST /leads/{lead_id}/certifications
leadsCertificationsDelete	DELETE /leads/{lead_id}/certifications/{certification_id}
leadsCertificationsIndex	GET /leads/{lead_id}/certifications
leadsCertificationsUpdate	PUT /leads/{lead_id}/certifications
leadsCompanysizesIndex	GET /leads/{lead_id}/companysizes
leadsCompanysizesUpdate	PUT /leads/{lead_id}/companysizes
leadsCreate	POST /leads
leadsDelete	DELETE /leads/{lead_id}
leadsDemopartnersIndex	GET /leads/demopartners/{partner_id}
leadsDemopartnersIndex_0	GET /leads/{lead_id}/demopartners/{partner_id}
leadsDiscardsCreate	POST /leads/discards
leadsExcludedpartnersCreate	POST /leads/{lead_id}/excludedpartners
leadsExcludedpartnersDelete	DELETE /leads/{lead_id}/excludedpartners/{partner_id}
leadsExcludedpartnersIndex	GET /leads/{lead_id}/excludedpartners
leadsGet	GET /leads/{lead_id}
leadsIndex	GET /leads
leadsNotesCreate	POST /leads/{lead_id}/notes
leadsQuotefeesCreate	POST /leads/{lead_id}/quotefees
leadsQuotefeesDelete	DELETE /leads/{lead_id}/quotefees
leadsQuotesActionsCreate	POST /leads/{lead_id}/quotes/{lead_quote_id}/actions
leadsQuotesCreate	POST /leads/{lead_id}/quotes
leadsQuotesDelete	DELETE /leads/{lead_id}/quotes/{lead_quote_id}
leadsQuotesGet	GET /leads/quotes/{lead_quote_id}
leadsQuotesGet_0	GET /leads/{lead_id}/quotes/{lead_quote_id}
leadsQuotesIndex	GET /leads/quotes
leadsQuotesIndex_0	GET /leads/{lead_id}/quotes
leadsQuotesItemsCreate	POST /leads/{lead_id}/quotes/{lead_quote_id}/items
leadsQuotesItemsDelete	DELETE /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
leadsQuotesItemsGet	GET /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
leadsQuotesItemsIndex	GET /leads/{lead_id}/quotes/{lead_quote_id}/items
leadsQuotesItemsUpdate	PUT /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
leadsQuotesLoansUpdate	PUT /leads/{lead_id}/quotes/{lead_quote_id}/loans/{lead_quote_loan_id}
leadsQuotesProgressstepsIndex	GET /leads/quotes/progresssteps
leadsQuotesUpdate	PUT /leads/quotes/{lead_quote_id}
leadsQuotesUpdate_0	PUT /leads/{lead_id}/quotes/{lead_quote_id}
leadsSegmentationsubgeoregionsIndex	GET /leads/{lead_id}/segmentationsubgeoregions
leadsSegmentationsubgeoregionsUpdate	PUT /leads/{lead_id}/segmentationsubgeoregions
leadsTypegroupsIndex	GET /leads/typegroups
leadsTypesIndex	GET /leads/types
leadsUpdate	PUT /leads/{lead_id}

leadsActionsCreate

\Ageras\Api\LeadResource leadsActionsCreate($lead_id , $lead_action_resource)

This function serves up one class with a lot of functionality

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_action_resource = new \Ageras\Api\LeadActionResource(); // \Ageras\Api\LeadActionResource | 

try {
    $result = $api_instance->leadsActionsCreate($lead_id , $lead_action_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsActionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_action_resource	\Ageras\Api\LeadActionResource

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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

leadsAggregationsIndex

\Ageras\Api\AggregationResult leadsAggregationsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'lead_id' => "lead_id_example"; // string | List of leads identification(ID).
        'phone' => "phone_example"; // string | Filter by a given phone number.
        'partner_id' => 56; // int | Provide a given partner id to filter by. Requires \"filter\" to be \"bought_by_partner\" or \"segmented_for_partner\".
        'geo_code' => ""; // string | Geographic Location Code.
        'sort' => "created_at"; // string | Sort Leads by a given attribute.
        'status' => "status_example"; // string | Status for the given lead.
        'client_id' => 56; // int | Lead's client
        'employee_id' => "employee_id_example"; // string | Lead's client's assigned employee ID
        'client_decision_postponed' => false; // bool | Client decision to choose a quote match is postponed or not.
        'all_quotes_published_before' => "all_quotes_published_before_example"; // string | Lead received its latest quote match before this date.
        'expires_within' => 56; // int | Get leads expiring within this many minutes.
        'industry' => "industry_example"; // string | Industry code for the given lead.
        'is_quotes_lead' => false; // bool | Get leads that are for quotes. @var bool
        'has_max_quotes' => false; // bool | Has maximum number of quotes. @var bool
        'has_accepted_quote' => false; // bool | Has an accepted quote. @var bool
        'has_rejected_quote' => false; // bool | Has a rejected quote. @var bool
        'no_quote_for_partner_id' => 56; // int | Get leads that do not have a quote for this partner ID. @var int
        'is_match_priority' => false; // bool | Is the lead prioritised for being matched? @var bool
        'is_completed_call_priority' => false; // bool | Is the lead prioritised for a completion call? @var bool
        'geo_point' => "geo_point_example"; // string | Location Point to sort leads by
        'geo_rect' => "geo_rect_example"; // string | Location Points to define an area to filter leads by. Provide the bottom left (southwest) and top right (northeast) corners of the reactangle separated by commas, e.g. \"52.19,12.42,52.85,14.22\".
        'geo_distance' => 56; // int | Location filter by distance
        'minimum_revenue_amount_excl_vat' => "minimum_revenue_amount_excl_vat_example"; // string | Get leads that will create at least this amount (in euros) of revenue if matched.
        'maximum_revenue_amount_excl_vat' => "maximum_revenue_amount_excl_vat_example"; // string | Get leads that will create no more than this amount (in euros) of revenue if matched.
        'lead_category' => "basic"; // string | Lead's category
        'validator_id' => "validator_id_example"; // string | Lead's validator
        'is_given_up' => false; // bool | Is the lead given up on?
        'industry_id' => "industry_id_example"; // string | Filter the leads by their industry ids
        'call_count_before_validation_lt' => 56; // int | Lead must have less than this many calls before validation occurred.
        'is_validation_postponed' => false; // bool | Is the lead's validation postponed?
        'created_at_lte' => "created_at_lte_example"; // string | Get leads created before this date (inclusive).
        'created_at_gte' => "created_at_gte_example"; // string | Get leads created after this date (inclusive).
        'validated_at_gte' => "validated_at_gte_example"; // string | Get leads validated after this date (inclusive).
        'latest_called_at_before' => "latest_called_at_before_example"; // string | Find leads with a latest call before this date.
        'segmentation_criteria' => "segmentation_criteria_example"; // string | Which criteria to segment on, e.g. language.
        'segmented_for_partner_business_unit_id' => 56; // int | List leads that are segmented for a business unit.
        'sub_geo_region_name' => "sub_geo_region_name_example"; // string | List leads in any of these sub geo regions. E.g. 'Aarhus', 'Copenhagen'.
        'is_anonymized' => false; // bool | Have the leads been anonymized.
        'has_lead_quote_fee' => false; // bool | Filter by has lead quote fee.
        'desired_partner_company_size_id' => "desired_partner_company_size_id_example"; // string | Filter by desired partner company size.
        'segmented_for_lead_marketplace_partner_id' => 56; // int | Find leads for the partner's lead marketplace.
        'personal_title_id' => "personal_title_id_example"; // string | Filter by lead's personal title
        'is_limited_access_marketplace_lead' => false; // bool | List marketplace leads that have been validated within limited access time window
        'is_basic_access_marketplace_lead' => false; // bool | List marketplace leads that have been created within basic access time window
        'type_id' => "type_id_example"; // string | List leads by the client type id
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsAggregationsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsAggregationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string	List of leads identification(ID).	[optional]
phone	string	Filter by a given phone number.	[optional]
partner_id	int	Provide a given partner id to filter by. Requires "filter" to be "bought_by_partner" or "segmented_for_partner".	[optional]
geo_code	string	Geographic Location Code.	[optional] [default to ]
sort	string	Sort Leads by a given attribute.	[optional] [default to created_at]
status	string	Status for the given lead.	[optional]
client_id	int	Lead's client	[optional]
employee_id	string	Lead's client's assigned employee ID	[optional]
client_decision_postponed	bool	Client decision to choose a quote match is postponed or not.	[optional] [default to false]
all_quotes_published_before	string	Lead received its latest quote match before this date.	[optional]
expires_within	int	Get leads expiring within this many minutes.	[optional]
industry	string	Industry code for the given lead.	[optional]
is_quotes_lead	bool	Get leads that are for quotes. @var bool	[optional] [default to false]
has_max_quotes	bool	Has maximum number of quotes. @var bool	[optional] [default to false]
has_accepted_quote	bool	Has an accepted quote. @var bool	[optional] [default to false]
has_rejected_quote	bool	Has a rejected quote. @var bool	[optional] [default to false]
no_quote_for_partner_id	int	Get leads that do not have a quote for this partner ID. @var int	[optional]
is_match_priority	bool	Is the lead prioritised for being matched? @var bool	[optional] [default to false]
is_completed_call_priority	bool	Is the lead prioritised for a completion call? @var bool	[optional] [default to false]
geo_point	string	Location Point to sort leads by	[optional]
geo_rect	string	Location Points to define an area to filter leads by. Provide the bottom left (southwest) and top right (northeast) corners of the reactangle separated by commas, e.g. "52.19,12.42,52.85,14.22".	[optional]
geo_distance	int	Location filter by distance	[optional]
minimum_revenue_amount_excl_vat	string	Get leads that will create at least this amount (in euros) of revenue if matched.	[optional]
maximum_revenue_amount_excl_vat	string	Get leads that will create no more than this amount (in euros) of revenue if matched.	[optional]
lead_category	string	Lead's category	[optional] [default to basic]
validator_id	string	Lead's validator	[optional]
is_given_up	bool	Is the lead given up on?	[optional] [default to false]
industry_id	string	Filter the leads by their industry ids	[optional]
call_count_before_validation_lt	int	Lead must have less than this many calls before validation occurred.	[optional]
is_validation_postponed	bool	Is the lead's validation postponed?	[optional] [default to false]
created_at_lte	string	Get leads created before this date (inclusive).	[optional]
created_at_gte	string	Get leads created after this date (inclusive).	[optional]
validated_at_gte	string	Get leads validated after this date (inclusive).	[optional]
latest_called_at_before	string	Find leads with a latest call before this date.	[optional]
segmentation_criteria	string	Which criteria to segment on, e.g. language.	[optional]
segmented_for_partner_business_unit_id	int	List leads that are segmented for a business unit.	[optional]
sub_geo_region_name	string	List leads in any of these sub geo regions. E.g. 'Aarhus', 'Copenhagen'.	[optional]
is_anonymized	bool	Have the leads been anonymized.	[optional] [default to false]
has_lead_quote_fee	bool	Filter by has lead quote fee.	[optional] [default to false]
desired_partner_company_size_id	string	Filter by desired partner company size.	[optional]
segmented_for_lead_marketplace_partner_id	int	Find leads for the partner's lead marketplace.	[optional]
personal_title_id	string	Filter by lead's personal title	[optional]
is_limited_access_marketplace_lead	bool	List marketplace leads that have been validated within limited access time window	[optional] [default to false]
is_basic_access_marketplace_lead	bool	List marketplace leads that have been created within basic access time window	[optional] [default to false]
type_id	string	List leads by the client type id	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AggregationResult

Authorization

jwt, login

HTTP request headers

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

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

leadsAllocationsCreate

\Ageras\Api\LeadAllocationsResource leadsAllocationsCreate($lead_id , $lead_allocations_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_allocations_resource = new \Ageras\Api\LeadAllocationsResource(); // \Ageras\Api\LeadAllocationsResource | 

try {
    $result = $api_instance->leadsAllocationsCreate($lead_id , $lead_allocations_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsAllocationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_allocations_resource	\Ageras\Api\LeadAllocationsResource

Return type

\Ageras\Api\LeadAllocationsResource

Authorization

jwt, login

HTTP request headers

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

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

leadsAllocationsIndex

\Ageras\Api\LeadPartnerAllocationResult leadsAllocationsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'lead_id' => 56; // int | Lead ID.
        'partner_id' => 56; // int | Partner ID.
        'partner_business_unit_id' => "partner_business_unit_id_example"; // string | Business Unit ID.
        'starts_at' => "starts_at_example"; // string | 
        'ends_at' => "ends_at_example"; // string | 
        'has_business_unit' => false; // bool | 
        'sort' => "created_at"; // string | 
        'is_used' => false; // bool | Filter by the allocation being used or unused.
        'is_processed' => false; // bool | Filter by the allocation being used or unused.
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsAllocationsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsAllocationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	int	Lead ID.	[optional]
partner_id	int	Partner ID.	[optional]
partner_business_unit_id	string	Business Unit ID.	[optional]
starts_at	string		[optional]
ends_at	string		[optional]
has_business_unit	bool		[optional] [default to false]
sort	string		[optional] [default to created_at]
is_used	bool	Filter by the allocation being used or unused.	[optional] [default to false]
is_processed	bool	Filter by the allocation being used or unused.	[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadPartnerAllocationResult

Authorization

jwt, login

HTTP request headers

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

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

leadsAllocationsuggestionsDelete

leadsAllocationsuggestionsDelete($lead_id, $allocation_suggestion_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$allocation_suggestion_id = "allocation_suggestion_id_example"; // string | 

try {
    $api_instance->leadsAllocationsuggestionsDelete($lead_id,  $allocation_suggestion_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsAllocationsuggestionsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
allocation_suggestion_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsCategoriesIndex

\Ageras\Api\LeadCategoryResult leadsCategoriesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'id' => "id_example"; // string | Category id @var int
        'identifier' => "identifier_example"; // string | Category identifier @var string
        'title' => "title_example"; // string | Category title. @var string
        'limit' => 56; // int | Limit of industries per page. @var int
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsCategoriesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCategoriesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Category id @var int	[optional]
identifier	string	Category identifier @var string	[optional]
title	string	Category title. @var string	[optional]
limit	int	Limit of industries per page. @var int	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadCategoryResult

Authorization

jwt, login

HTTP request headers

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

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

leadsCertificationsCreate

\Ageras\Api\CertificationResource leadsCertificationsCreate($lead_id , $certification_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$certification_resource = new \Ageras\Api\CertificationResource(); // \Ageras\Api\CertificationResource | 

try {
    $result = $api_instance->leadsCertificationsCreate($lead_id , $certification_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCertificationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
certification_resource	\Ageras\Api\CertificationResource

Return type

\Ageras\Api\CertificationResource

Authorization

jwt, login

HTTP request headers

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

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

leadsCertificationsDelete

leadsCertificationsDelete($lead_id, $certification_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$certification_id = "certification_id_example"; // string | 

try {
    $api_instance->leadsCertificationsDelete($lead_id,  $certification_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCertificationsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
certification_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsCertificationsIndex

\Ageras\Api\CertificationResult leadsCertificationsIndex($lead_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$criteria = [
        'is_segmentable' => false; // bool | Is the certification used for segmentation?
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsCertificationsIndex($lead_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCertificationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
is_segmentable	bool	Is the certification used for segmentation?	[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\CertificationResult

Authorization

jwt, login

HTTP request headers

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

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

leadsCertificationsUpdate

\Ageras\Api\CertificationResource leadsCertificationsUpdate($lead_id , $lead_certifications_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_certifications_resource = new \Ageras\Api\LeadCertificationsResource(); // \Ageras\Api\LeadCertificationsResource | 

try {
    $result = $api_instance->leadsCertificationsUpdate($lead_id , $lead_certifications_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCertificationsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_certifications_resource	\Ageras\Api\LeadCertificationsResource

Return type

\Ageras\Api\CertificationResource

Authorization

jwt, login

HTTP request headers

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

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

leadsCompanysizesIndex

\Ageras\Api\LeadCompanySizesResult leadsCompanysizesIndex($lead_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$criteria = [
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsCompanysizesIndex($lead_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCompanysizesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadCompanySizesResult

Authorization

jwt, login

HTTP request headers

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

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

leadsCompanysizesUpdate

\Ageras\Api\LeadCompanySizesResource leadsCompanysizesUpdate($lead_id , $lead_company_sizes_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_company_sizes_resource = new \Ageras\Api\LeadCompanySizesResource(); // \Ageras\Api\LeadCompanySizesResource | 

try {
    $result = $api_instance->leadsCompanysizesUpdate($lead_id , $lead_company_sizes_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCompanysizesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_company_sizes_resource	\Ageras\Api\LeadCompanySizesResource

Return type

\Ageras\Api\LeadCompanySizesResource

Authorization

jwt, login

HTTP request headers

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

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

leadsCreate

\Ageras\Api\LeadResource leadsCreate($lead_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_resource = new \Ageras\Api\LeadResource(); // \Ageras\Api\LeadResource | 

try {
    $result = $api_instance->leadsCreate($lead_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_resource	\Ageras\Api\LeadResource

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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

leadsDelete

leadsDelete($lead_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 

try {
    $api_instance->leadsDelete($lead_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsDemopartnersIndex

\Ageras\Api\LeadResult leadsDemopartnersIndex($partner_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$partner_id = "partner_id_example"; // string | 

try {
    $result = $api_instance->leadsDemopartnersIndex($partner_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsDemopartnersIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
partner_id	string

Return type

\Ageras\Api\LeadResult

Authorization

jwt, login

HTTP request headers

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

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

leadsDemopartnersIndex_0

\Ageras\Api\LeadResult leadsDemopartnersIndex_0($lead_id, $partner_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$partner_id = "partner_id_example"; // string | 

try {
    $result = $api_instance->leadsDemopartnersIndex_0($lead_id,  $partner_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsDemopartnersIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
partner_id	string

Return type

\Ageras\Api\LeadResult

Authorization

jwt, login

HTTP request headers

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

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

leadsDiscardsCreate

\Ageras\Api\LeadBulkActionDiscardResource leadsDiscardsCreate($lead_bulk_action_discard_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_bulk_action_discard_resource = new \Ageras\Api\LeadBulkActionDiscardResource(); // \Ageras\Api\LeadBulkActionDiscardResource | 

try {
    $result = $api_instance->leadsDiscardsCreate($lead_bulk_action_discard_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsDiscardsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_bulk_action_discard_resource	\Ageras\Api\LeadBulkActionDiscardResource

Return type

\Ageras\Api\LeadBulkActionDiscardResource

Authorization

jwt, login

HTTP request headers

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

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

leadsExcludedpartnersCreate

\Ageras\Api\LeadResource leadsExcludedpartnersCreate($lead_id , $partner_suggest_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$partner_suggest_resource = new \Ageras\Api\PartnerSuggestResource(); // \Ageras\Api\PartnerSuggestResource | 

try {
    $result = $api_instance->leadsExcludedpartnersCreate($lead_id , $partner_suggest_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsExcludedpartnersCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
partner_suggest_resource	\Ageras\Api\PartnerSuggestResource

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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

leadsExcludedpartnersDelete

leadsExcludedpartnersDelete($lead_id, $partner_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$partner_id = "partner_id_example"; // string | 

try {
    $api_instance->leadsExcludedpartnersDelete($lead_id,  $partner_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsExcludedpartnersDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
partner_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsExcludedpartnersIndex

\Ageras\Api\LeadPartnerResult leadsExcludedpartnersIndex($lead_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$criteria = [
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsExcludedpartnersIndex($lead_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsExcludedpartnersIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadPartnerResult

Authorization

jwt, login

HTTP request headers

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

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

leadsGet

\Ageras\Api\LeadResource leadsGet($lead_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 

try {
    $result = $api_instance->leadsGet($lead_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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

leadsIndex

\Ageras\Api\LeadResult leadsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'lead_id' => "lead_id_example"; // string | List of leads identification(ID).
        'phone' => "phone_example"; // string | Filter by a given phone number.
        'partner_id' => 56; // int | Provide a given partner id to filter by. Requires \"filter\" to be \"bought_by_partner\" or \"segmented_for_partner\".
        'geo_code' => ""; // string | Geographic Location Code.
        'sort' => "created_at"; // string | Sort Leads by a given attribute.
        'status' => "status_example"; // string | Status for the given lead.
        'client_id' => 56; // int | Lead's client
        'employee_id' => "employee_id_example"; // string | Lead's client's assigned employee ID
        'client_decision_postponed' => false; // bool | Client decision to choose a quote match is postponed or not.
        'all_quotes_published_before' => "all_quotes_published_before_example"; // string | Lead received its latest quote match before this date.
        'expires_within' => 56; // int | Get leads expiring within this many minutes.
        'industry' => "industry_example"; // string | Industry code for the given lead.
        'is_quotes_lead' => false; // bool | Get leads that are for quotes. @var bool
        'has_max_quotes' => false; // bool | Has maximum number of quotes. @var bool
        'has_accepted_quote' => false; // bool | Has an accepted quote. @var bool
        'has_rejected_quote' => false; // bool | Has a rejected quote. @var bool
        'no_quote_for_partner_id' => 56; // int | Get leads that do not have a quote for this partner ID. @var int
        'is_match_priority' => false; // bool | Is the lead prioritised for being matched? @var bool
        'is_completed_call_priority' => false; // bool | Is the lead prioritised for a completion call? @var bool
        'geo_point' => "geo_point_example"; // string | Location Point to sort leads by
        'geo_rect' => "geo_rect_example"; // string | Location Points to define an area to filter leads by. Provide the bottom left (southwest) and top right (northeast) corners of the reactangle separated by commas, e.g. \"52.19,12.42,52.85,14.22\".
        'geo_distance' => 56; // int | Location filter by distance
        'minimum_revenue_amount_excl_vat' => "minimum_revenue_amount_excl_vat_example"; // string | Get leads that will create at least this amount (in euros) of revenue if matched.
        'maximum_revenue_amount_excl_vat' => "maximum_revenue_amount_excl_vat_example"; // string | Get leads that will create no more than this amount (in euros) of revenue if matched.
        'lead_category' => "basic"; // string | Lead's category
        'validator_id' => "validator_id_example"; // string | Lead's validator
        'is_given_up' => false; // bool | Is the lead given up on?
        'industry_id' => "industry_id_example"; // string | Filter the leads by their industry ids
        'call_count_before_validation_lt' => 56; // int | Lead must have less than this many calls before validation occurred.
        'is_validation_postponed' => false; // bool | Is the lead's validation postponed?
        'created_at_lte' => "created_at_lte_example"; // string | Get leads created before this date (inclusive).
        'created_at_gte' => "created_at_gte_example"; // string | Get leads created after this date (inclusive).
        'validated_at_gte' => "validated_at_gte_example"; // string | Get leads validated after this date (inclusive).
        'latest_called_at_before' => "latest_called_at_before_example"; // string | Find leads with a latest call before this date.
        'segmentation_criteria' => "segmentation_criteria_example"; // string | Which criteria to segment on, e.g. language.
        'segmented_for_partner_business_unit_id' => 56; // int | List leads that are segmented for a business unit.
        'sub_geo_region_name' => "sub_geo_region_name_example"; // string | List leads in any of these sub geo regions. E.g. 'Aarhus', 'Copenhagen'.
        'is_anonymized' => false; // bool | Have the leads been anonymized.
        'has_lead_quote_fee' => false; // bool | Filter by has lead quote fee.
        'desired_partner_company_size_id' => "desired_partner_company_size_id_example"; // string | Filter by desired partner company size.
        'segmented_for_lead_marketplace_partner_id' => 56; // int | Find leads for the partner's lead marketplace.
        'personal_title_id' => "personal_title_id_example"; // string | Filter by lead's personal title
        'is_limited_access_marketplace_lead' => false; // bool | List marketplace leads that have been validated within limited access time window
        'is_basic_access_marketplace_lead' => false; // bool | List marketplace leads that have been created within basic access time window
        'type_id' => "type_id_example"; // string | List leads by the client type id
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string	List of leads identification(ID).	[optional]
phone	string	Filter by a given phone number.	[optional]
partner_id	int	Provide a given partner id to filter by. Requires "filter" to be "bought_by_partner" or "segmented_for_partner".	[optional]
geo_code	string	Geographic Location Code.	[optional] [default to ]
sort	string	Sort Leads by a given attribute.	[optional] [default to created_at]
status	string	Status for the given lead.	[optional]
client_id	int	Lead's client	[optional]
employee_id	string	Lead's client's assigned employee ID	[optional]
client_decision_postponed	bool	Client decision to choose a quote match is postponed or not.	[optional] [default to false]
all_quotes_published_before	string	Lead received its latest quote match before this date.	[optional]
expires_within	int	Get leads expiring within this many minutes.	[optional]
industry	string	Industry code for the given lead.	[optional]
is_quotes_lead	bool	Get leads that are for quotes. @var bool	[optional] [default to false]
has_max_quotes	bool	Has maximum number of quotes. @var bool	[optional] [default to false]
has_accepted_quote	bool	Has an accepted quote. @var bool	[optional] [default to false]
has_rejected_quote	bool	Has a rejected quote. @var bool	[optional] [default to false]
no_quote_for_partner_id	int	Get leads that do not have a quote for this partner ID. @var int	[optional]
is_match_priority	bool	Is the lead prioritised for being matched? @var bool	[optional] [default to false]
is_completed_call_priority	bool	Is the lead prioritised for a completion call? @var bool	[optional] [default to false]
geo_point	string	Location Point to sort leads by	[optional]
geo_rect	string	Location Points to define an area to filter leads by. Provide the bottom left (southwest) and top right (northeast) corners of the reactangle separated by commas, e.g. "52.19,12.42,52.85,14.22".	[optional]
geo_distance	int	Location filter by distance	[optional]
minimum_revenue_amount_excl_vat	string	Get leads that will create at least this amount (in euros) of revenue if matched.	[optional]
maximum_revenue_amount_excl_vat	string	Get leads that will create no more than this amount (in euros) of revenue if matched.	[optional]
lead_category	string	Lead's category	[optional] [default to basic]
validator_id	string	Lead's validator	[optional]
is_given_up	bool	Is the lead given up on?	[optional] [default to false]
industry_id	string	Filter the leads by their industry ids	[optional]
call_count_before_validation_lt	int	Lead must have less than this many calls before validation occurred.	[optional]
is_validation_postponed	bool	Is the lead's validation postponed?	[optional] [default to false]
created_at_lte	string	Get leads created before this date (inclusive).	[optional]
created_at_gte	string	Get leads created after this date (inclusive).	[optional]
validated_at_gte	string	Get leads validated after this date (inclusive).	[optional]
latest_called_at_before	string	Find leads with a latest call before this date.	[optional]
segmentation_criteria	string	Which criteria to segment on, e.g. language.	[optional]
segmented_for_partner_business_unit_id	int	List leads that are segmented for a business unit.	[optional]
sub_geo_region_name	string	List leads in any of these sub geo regions. E.g. 'Aarhus', 'Copenhagen'.	[optional]
is_anonymized	bool	Have the leads been anonymized.	[optional] [default to false]
has_lead_quote_fee	bool	Filter by has lead quote fee.	[optional] [default to false]
desired_partner_company_size_id	string	Filter by desired partner company size.	[optional]
segmented_for_lead_marketplace_partner_id	int	Find leads for the partner's lead marketplace.	[optional]
personal_title_id	string	Filter by lead's personal title	[optional]
is_limited_access_marketplace_lead	bool	List marketplace leads that have been validated within limited access time window	[optional] [default to false]
is_basic_access_marketplace_lead	bool	List marketplace leads that have been created within basic access time window	[optional] [default to false]
type_id	string	List leads by the client type id	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadResult

Authorization

jwt, login

HTTP request headers

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

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

leadsNotesCreate

\Ageras\Api\LeadResource leadsNotesCreate($lead_id , $lead_note_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_note_resource = new \Ageras\Api\LeadNoteResource(); // \Ageras\Api\LeadNoteResource | 

try {
    $result = $api_instance->leadsNotesCreate($lead_id , $lead_note_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsNotesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_note_resource	\Ageras\Api\LeadNoteResource

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotefeesCreate

\Ageras\Api\LeadQuoteFeeResource leadsQuotefeesCreate($lead_id , $lead_quote_fee_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_fee_resource = new \Ageras\Api\LeadQuoteFeeResource(); // \Ageras\Api\LeadQuoteFeeResource | 

try {
    $result = $api_instance->leadsQuotefeesCreate($lead_id , $lead_quote_fee_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotefeesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_fee_resource	\Ageras\Api\LeadQuoteFeeResource

Return type

\Ageras\Api\LeadQuoteFeeResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotefeesDelete

leadsQuotefeesDelete($lead_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 

try {
    $api_instance->leadsQuotefeesDelete($lead_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotefeesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesActionsCreate

\Ageras\Api\LeadQuoteResource leadsQuotesActionsCreate($lead_id, $lead_quote_id , $lead_quote_action_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_action_resource = new \Ageras\Api\LeadQuoteActionResource(); // \Ageras\Api\LeadQuoteActionResource | 

try {
    $result = $api_instance->leadsQuotesActionsCreate($lead_id,  $lead_quote_id , $lead_quote_action_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesActionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_action_resource	\Ageras\Api\LeadQuoteActionResource

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesCreate

\Ageras\Api\LeadQuoteResource leadsQuotesCreate($lead_id , $lead_quote_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_resource = new \Ageras\Api\LeadQuoteResource(); // \Ageras\Api\LeadQuoteResource | 

try {
    $result = $api_instance->leadsQuotesCreate($lead_id , $lead_quote_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_resource	\Ageras\Api\LeadQuoteResource

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesDelete

leadsQuotesDelete($lead_id, $lead_quote_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 

try {
    $api_instance->leadsQuotesDelete($lead_id,  $lead_quote_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesGet

\Ageras\Api\LeadQuoteResource leadsQuotesGet($lead_quote_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_quote_id = "lead_quote_id_example"; // string | 

try {
    $result = $api_instance->leadsQuotesGet($lead_quote_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_quote_id	string

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesGet_0

\Ageras\Api\LeadQuoteResource leadsQuotesGet_0($lead_id, $lead_quote_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 

try {
    $result = $api_instance->leadsQuotesGet_0($lead_id,  $lead_quote_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesIndex

\Ageras\Api\LeadQuoteResult leadsQuotesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'client_id' => "client_id_example"; // string | List of quotes by client_id
        'lead_id' => "lead_id_example"; // string | List of leads identification(ID).
        'lead_quote_id' => "lead_quote_id_example"; // string | List of lead quotes identification(ID).
        'partner_id' => "partner_id_example"; // string | Offers belonging to a given partner.
        'geo_code' => "geo_code_example"; // string | Geographic Location Code.
        'is_accepted' => false; // bool | Quote is accepted.
        'is_published' => false; // bool | Quote is published.
        'is_rejected' => false; // bool | Quote is rejected.
        'sort' => "created_at"; // string | Sort options.
        'lead_category_type' => "lead_category_type_example"; // string | Filter by lead category type.
        'reservation_is_expired' => false; // bool | Quote's reservation is expired.
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsQuotesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
client_id	string	List of quotes by client_id	[optional]
lead_id	string	List of leads identification(ID).	[optional]
lead_quote_id	string	List of lead quotes identification(ID).	[optional]
partner_id	string	Offers belonging to a given partner.	[optional]
geo_code	string	Geographic Location Code.	[optional]
is_accepted	bool	Quote is accepted.	[optional] [default to false]
is_published	bool	Quote is published.	[optional] [default to false]
is_rejected	bool	Quote is rejected.	[optional] [default to false]
sort	string	Sort options.	[optional] [default to created_at]
lead_category_type	string	Filter by lead category type.	[optional]
reservation_is_expired	bool	Quote's reservation is expired.	[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadQuoteResult

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesIndex_0

\Ageras\Api\LeadQuoteResult leadsQuotesIndex_0($lead_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$criteria = [
        'client_id' => "client_id_example"; // string | List of quotes by client_id
        'lead_quote_id' => "lead_quote_id_example"; // string | List of lead quotes identification(ID).
        'partner_id' => "partner_id_example"; // string | Offers belonging to a given partner.
        'geo_code' => "geo_code_example"; // string | Geographic Location Code.
        'is_accepted' => false; // bool | Quote is accepted.
        'is_published' => false; // bool | Quote is published.
        'is_rejected' => false; // bool | Quote is rejected.
        'sort' => "created_at"; // string | Sort options.
        'lead_category_type' => "lead_category_type_example"; // string | Filter by lead category type.
        'reservation_is_expired' => false; // bool | Quote's reservation is expired.
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsQuotesIndex_0($lead_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
client_id	string	List of quotes by client_id	[optional]
lead_quote_id	string	List of lead quotes identification(ID).	[optional]
partner_id	string	Offers belonging to a given partner.	[optional]
geo_code	string	Geographic Location Code.	[optional]
is_accepted	bool	Quote is accepted.	[optional] [default to false]
is_published	bool	Quote is published.	[optional] [default to false]
is_rejected	bool	Quote is rejected.	[optional] [default to false]
sort	string	Sort options.	[optional] [default to created_at]
lead_category_type	string	Filter by lead category type.	[optional]
reservation_is_expired	bool	Quote's reservation is expired.	[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadQuoteResult

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesItemsCreate

\Ageras\Api\LeadQuoteItemResource leadsQuotesItemsCreate($lead_id, $lead_quote_id , $lead_quote_item_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_item_resource = new \Ageras\Api\LeadQuoteItemResource(); // \Ageras\Api\LeadQuoteItemResource | 

try {
    $result = $api_instance->leadsQuotesItemsCreate($lead_id,  $lead_quote_id , $lead_quote_item_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesItemsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_item_resource	\Ageras\Api\LeadQuoteItemResource

Return type

\Ageras\Api\LeadQuoteItemResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesItemsDelete

leadsQuotesItemsDelete($lead_id, $lead_quote_id, $lead_quote_item_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_item_id = "lead_quote_item_id_example"; // string | 

try {
    $api_instance->leadsQuotesItemsDelete($lead_id,  $lead_quote_id,  $lead_quote_item_id );
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesItemsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_item_id	string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesItemsGet

\Ageras\Api\LeadQuoteItemResource leadsQuotesItemsGet($lead_id, $lead_quote_id, $lead_quote_item_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_item_id = "lead_quote_item_id_example"; // string | 

try {
    $result = $api_instance->leadsQuotesItemsGet($lead_id,  $lead_quote_id,  $lead_quote_item_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesItemsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_item_id	string

Return type

\Ageras\Api\LeadQuoteItemResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesItemsIndex

\Ageras\Api\LeadQuoteItemResult leadsQuotesItemsIndex($lead_id, $lead_quote_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$criteria = [
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsQuotesItemsIndex($lead_id,  $lead_quote_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesItemsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadQuoteItemResult

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesItemsUpdate

\Ageras\Api\LeadQuoteItemResource leadsQuotesItemsUpdate($lead_id, $lead_quote_id, $lead_quote_item_id , $lead_quote_item_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_item_id = "lead_quote_item_id_example"; // string | 
$lead_quote_item_resource = new \Ageras\Api\LeadQuoteItemResource(); // \Ageras\Api\LeadQuoteItemResource | 

try {
    $result = $api_instance->leadsQuotesItemsUpdate($lead_id,  $lead_quote_id,  $lead_quote_item_id , $lead_quote_item_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesItemsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_item_id	string
lead_quote_item_resource	\Ageras\Api\LeadQuoteItemResource

Return type

\Ageras\Api\LeadQuoteItemResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesLoansUpdate

\Ageras\Api\LeadQuoteLoanResource leadsQuotesLoansUpdate($lead_id, $lead_quote_id, $lead_quote_loan_id , $lead_quote_loan_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_loan_id = "lead_quote_loan_id_example"; // string | 
$lead_quote_loan_resource = new \Ageras\Api\LeadQuoteLoanResource(); // \Ageras\Api\LeadQuoteLoanResource | 

try {
    $result = $api_instance->leadsQuotesLoansUpdate($lead_id,  $lead_quote_id,  $lead_quote_loan_id , $lead_quote_loan_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesLoansUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_loan_id	string
lead_quote_loan_resource	\Ageras\Api\LeadQuoteLoanResource

Return type

\Ageras\Api\LeadQuoteLoanResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesProgressstepsIndex

\Ageras\Api\LeadQuoteProgressResult leadsQuotesProgressstepsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'title' => "title_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsQuotesProgressstepsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesProgressstepsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
title	string		[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadQuoteProgressResult

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesUpdate

\Ageras\Api\LeadQuoteResource leadsQuotesUpdate($lead_quote_id , $lead_quote_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_resource = new \Ageras\Api\LeadQuoteResource(); // \Ageras\Api\LeadQuoteResource | 

try {
    $result = $api_instance->leadsQuotesUpdate($lead_quote_id , $lead_quote_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_quote_id	string
lead_quote_resource	\Ageras\Api\LeadQuoteResource

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsQuotesUpdate_0

\Ageras\Api\LeadQuoteResource leadsQuotesUpdate_0($lead_id, $lead_quote_id , $lead_quote_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_quote_id = "lead_quote_id_example"; // string | 
$lead_quote_resource = new \Ageras\Api\LeadQuoteResource(); // \Ageras\Api\LeadQuoteResource | 

try {
    $result = $api_instance->leadsQuotesUpdate_0($lead_id,  $lead_quote_id , $lead_quote_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsQuotesUpdate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_quote_id	string
lead_quote_resource	\Ageras\Api\LeadQuoteResource

Return type

\Ageras\Api\LeadQuoteResource

Authorization

jwt, login

HTTP request headers

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

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

leadsSegmentationsubgeoregionsIndex

\Ageras\Api\SegmentationSubGeoRegionResult leadsSegmentationsubgeoregionsIndex($lead_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$criteria = [
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsSegmentationsubgeoregionsIndex($lead_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsSegmentationsubgeoregionsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\SegmentationSubGeoRegionResult

Authorization

jwt, login

HTTP request headers

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

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

leadsSegmentationsubgeoregionsUpdate

\Ageras\Api\SegmentationSubGeoRegionsResource leadsSegmentationsubgeoregionsUpdate($lead_id , $segmentation_sub_geo_regions_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$segmentation_sub_geo_regions_resource = new \Ageras\Api\SegmentationSubGeoRegionsResource(); // \Ageras\Api\SegmentationSubGeoRegionsResource | 

try {
    $result = $api_instance->leadsSegmentationsubgeoregionsUpdate($lead_id , $segmentation_sub_geo_regions_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsSegmentationsubgeoregionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
segmentation_sub_geo_regions_resource	\Ageras\Api\SegmentationSubGeoRegionsResource

Return type

\Ageras\Api\SegmentationSubGeoRegionsResource

Authorization

jwt, login

HTTP request headers

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

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

leadsTypegroupsIndex

\Ageras\Api\LeadTypeGroupResult leadsTypegroupsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'geo_code' => "geo_code_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsTypegroupsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsTypegroupsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
geo_code	string		[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadTypeGroupResult

Authorization

jwt, login

HTTP request headers

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

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

leadsTypesIndex

\Ageras\Api\LeadTypeResult leadsTypesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$criteria = [
        'type_id' => "type_id_example"; // string | Type ID. @var int
        'title' => "title_example"; // string | Type title in its native language. @var string
        'geo_code' => "geo_code_example"; // string | Industry geo code origin. @var string
        'limit' => 56; // int | Limit of industries per page. @var int
        'is_archived' => false; // bool | 
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->leadsTypesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsTypesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
type_id	string	Type ID. @var int	[optional]
title	string	Type title in its native language. @var string	[optional]
geo_code	string	Industry geo code origin. @var string	[optional]
limit	int	Limit of industries per page. @var int	[optional]
is_archived	bool		[optional] [default to false]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\LeadTypeResult

Authorization

jwt, login

HTTP request headers

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

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

leadsUpdate

\Ageras\Api\LeadResource leadsUpdate($lead_id , $lead_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\LeadsApi();
$lead_id = "lead_id_example"; // string | 
$lead_resource = new \Ageras\Api\LeadResource(); // \Ageras\Api\LeadResource | 

try {
    $result = $api_instance->leadsUpdate($lead_id , $lead_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LeadsApi->leadsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	string
lead_resource	\Ageras\Api\LeadResource

Return type

\Ageras\Api\LeadResource

Authorization

jwt, login

HTTP request headers

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

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