Spinen\ConnectWise\Clients\Marketing\CampaignsApi

Spinen's PHP ConnectWise Client for Marketing API generated by Swagger Code Generator.

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method	HTTP request	Description
marketingCampaignsCountGet	GET /marketing/campaigns/count
marketingCampaignsGet	GET /marketing/campaigns
marketingCampaignsIdActivitiesCountGet	GET /marketing/campaigns/{id}/activities/count
marketingCampaignsIdActivitiesGet	GET /marketing/campaigns/{id}/activities
marketingCampaignsIdDelete	DELETE /marketing/campaigns/{id}
marketingCampaignsIdGet	GET /marketing/campaigns/{id}
marketingCampaignsIdOpportunitiesCountGet	GET /marketing/campaigns/{id}/opportunities/count
marketingCampaignsIdOpportunitiesGet	GET /marketing/campaigns/{id}/opportunities
marketingCampaignsIdPatch	PATCH /marketing/campaigns/{id}
marketingCampaignsIdPut	PUT /marketing/campaigns/{id}
marketingCampaignsPost	POST /marketing/campaigns

marketingCampaignsCountGet

\Spinen\ConnectWise\Clients\Marketing\Model\Count marketingCampaignsCountGet($conditions)

Get Campaigns Count

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name	Type	Description	Notes
conditions	string		[optional]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Count

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsGet

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign[] marketingCampaignsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Campaigns

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->marketingCampaignsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
conditions	string	[optional]
order_by	string	[optional]
childconditions	string	[optional]
customfieldconditions	string	[optional]
page	int	[optional]
page_size	int	[optional]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign[]

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdActivitiesCountGet

\Spinen\ConnectWise\Clients\Marketing\Model\Count marketingCampaignsIdActivitiesCountGet($id)

Get Campaign Activities Count

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Count

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdActivitiesGet

\Spinen\ConnectWise\Clients\Marketing\Model\ActivityReference[] marketingCampaignsIdActivitiesGet($id, $page, $page_size)

Get Campaign Activities

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->marketingCampaignsIdActivitiesGet($id, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsIdActivitiesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
page	int	[optional]
page_size	int	[optional]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\ActivityReference[]

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdDelete

marketingCampaignsIdDelete($id)

Delete Campaign By Id

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 

try {
    $api_instance->marketingCampaignsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

marketingCampaignsIdGet

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign marketingCampaignsIdGet($id)

Get Campaign By Id

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdOpportunitiesCountGet

\Spinen\ConnectWise\Clients\Marketing\Model\Count marketingCampaignsIdOpportunitiesCountGet($id)

Get Campaign Opportunities Count

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Count

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdOpportunitiesGet

\Spinen\ConnectWise\Clients\Marketing\Model\OpportunityReference[] marketingCampaignsIdOpportunitiesGet($id, $page, $page_size)

Get Campaign Opportunities

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->marketingCampaignsIdOpportunitiesGet($id, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsIdOpportunitiesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
page	int	[optional]
page_size	int	[optional]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\OpportunityReference[]

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

marketingCampaignsIdPatch

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign marketingCampaignsIdPatch($id, $operations)

Update Campaign

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Marketing\Model\PatchOperation[] | 

try {
    $result = $api_instance->marketingCampaignsIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
operations	\Spinen\ConnectWise\Clients\Marketing\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Authorization

BasicAuth

HTTP request headers

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

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

marketingCampaignsIdPut

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign marketingCampaignsIdPut($id, $campaign)

Replace Campaign

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$id = 56; // int | 
$campaign = new \Spinen\ConnectWise\Clients\Marketing\Model\Campaign(); // \Spinen\ConnectWise\Clients\Marketing\Model\Campaign | 

try {
    $result = $api_instance->marketingCampaignsIdPut($id, $campaign);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->marketingCampaignsIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
campaign	\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Authorization

BasicAuth

HTTP request headers

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

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

marketingCampaignsPost

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign marketingCampaignsPost($campaign)

Create Campaign

Example

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Marketing\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignsApi();
$campaign = new \Spinen\ConnectWise\Clients\Marketing\Model\Campaign(); // \Spinen\ConnectWise\Clients\Marketing\Model\Campaign | 

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

Parameters

Name	Type	Description	Notes
campaign	\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\Campaign

Authorization

BasicAuth

HTTP request headers

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

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

Files

CampaignsApi.md

Latest commit

History

CampaignsApi.md

File metadata and controls

Spinen\ConnectWise\Clients\Marketing\CampaignsApi

marketingCampaignsCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdActivitiesCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdActivitiesGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdOpportunitiesCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdOpportunitiesGet

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

marketingCampaignsPost

Example

Parameters

Return type

Authorization

HTTP request headers