Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 10.3 KB

CampaignLinksClickedApi.md

File metadata and controls

413 lines (269 loc) · 10.3 KB
Raw

Connectwise::CampaignLinksClickedApi

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

Method HTTP request Description
marketing_campaigns_id_links_clicked_count_get GET /marketing/campaigns/{id}/linksClicked/count
marketing_campaigns_id_links_clicked_get GET /marketing/campaigns/{id}/linksClicked
marketing_campaigns_id_links_clicked_link_clicked_id_delete DELETE /marketing/campaigns/{id}/linksClicked/{linkClickedId}
marketing_campaigns_id_links_clicked_link_clicked_id_get GET /marketing/campaigns/{id}/linksClicked/{linkClickedId}
marketing_campaigns_id_links_clicked_link_clicked_id_patch PATCH /marketing/campaigns/{id}/linksClicked/{linkClickedId}
marketing_campaigns_id_links_clicked_link_clicked_id_put PUT /marketing/campaigns/{id}/linksClicked/{linkClickedId}
marketing_campaigns_id_links_clicked_post POST /marketing/campaigns/{id}/linksClicked

marketing_campaigns_id_links_clicked_count_get

Count marketing_campaigns_id_links_clicked_count_get(id, opts)

Get Links Clicked Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.marketing_campaigns_id_links_clicked_count_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_count_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_links_clicked_get

Array<LinkClicked> marketing_campaigns_id_links_clicked_get(id, opts)

Get Links Clicked

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.marketing_campaigns_id_links_clicked_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<LinkClicked>

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_links_clicked_link_clicked_id_delete

marketing_campaigns_id_links_clicked_link_clicked_id_delete(id, link_clicked_id)

Delete Link Clicked By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

link_clicked_id = 56 # Integer | 


begin
  api_instance.marketing_campaigns_id_links_clicked_link_clicked_id_delete(id, link_clicked_id)
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_link_clicked_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link_clicked_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

marketing_campaigns_id_links_clicked_link_clicked_id_get

LinkClicked marketing_campaigns_id_links_clicked_link_clicked_id_get(id, link_clicked_id)

Get Link Clicked By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

link_clicked_id = 56 # Integer | 


begin
  result = api_instance.marketing_campaigns_id_links_clicked_link_clicked_id_get(id, link_clicked_id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_link_clicked_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link_clicked_id Integer

Return type

LinkClicked

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_links_clicked_link_clicked_id_patch

LinkClicked marketing_campaigns_id_links_clicked_link_clicked_id_patch(id, link_clicked_id, operations)

Update Link Clicked

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

link_clicked_id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.marketing_campaigns_id_links_clicked_link_clicked_id_patch(id, link_clicked_id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_link_clicked_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link_clicked_id Integer
operations Array<PatchOperation>

Return type

LinkClicked

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_links_clicked_link_clicked_id_put

LinkClicked marketing_campaigns_id_links_clicked_link_clicked_id_put(id, link_clicked_id, link_clicked)

Replace Link Clicked

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

link_clicked_id = 56 # Integer | 

link_clicked = Connectwise::LinkClicked.new # LinkClicked | 


begin
  result = api_instance.marketing_campaigns_id_links_clicked_link_clicked_id_put(id, link_clicked_id, link_clicked)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_link_clicked_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link_clicked_id Integer
link_clicked LinkClicked

Return type

LinkClicked

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_links_clicked_post

LinkClicked marketing_campaigns_id_links_clicked_post(id, link_clicked)

Create Link Clicked

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CampaignLinksClickedApi.new

id = 56 # Integer | 

link_clicked = Connectwise::LinkClicked.new # LinkClicked | 


begin
  result = api_instance.marketing_campaigns_id_links_clicked_post(id, link_clicked)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CampaignLinksClickedApi->marketing_campaigns_id_links_clicked_post: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link_clicked LinkClicked

Return type

LinkClicked

Authorization

BasicAuth

HTTP request headers

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