Skip to content

Latest commit

 

History

History
417 lines (273 loc) · 10.5 KB

CampaignEmailsOpenedApi.md

File metadata and controls

417 lines (273 loc) · 10.5 KB
Raw

ConnectWise::CampaignEmailsOpenedApi

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

Method HTTP request Description
marketing_campaigns_id_emails_opened_count_get GET /marketing/campaigns/{id}/emailsOpened/count
marketing_campaigns_id_emails_opened_email_opened_id_delete DELETE /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
marketing_campaigns_id_emails_opened_email_opened_id_get GET /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
marketing_campaigns_id_emails_opened_email_opened_id_patch PATCH /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
marketing_campaigns_id_emails_opened_email_opened_id_put PUT /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
marketing_campaigns_id_emails_opened_get GET /marketing/campaigns/{id}/emailsOpened
marketing_campaigns_id_emails_opened_post POST /marketing/campaigns/{id}/emailsOpened

marketing_campaigns_id_emails_opened_count_get

Count marketing_campaigns_id_emails_opened_count_get(id, opts)

Get Emails Opened 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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

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

begin
  result = api_instance.marketing_campaigns_id_emails_opened_count_get(id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_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_emails_opened_email_opened_id_delete

marketing_campaigns_id_emails_opened_email_opened_id_delete(id, email_opened_id)

Delete Email Opened 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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

email_opened_id = 56 # Integer | 


begin
  api_instance.marketing_campaigns_id_emails_opened_email_opened_id_delete(id, email_opened_id)
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_email_opened_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
email_opened_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_emails_opened_email_opened_id_get

EmailOpened marketing_campaigns_id_emails_opened_email_opened_id_get(id, email_opened_id)

Get Email Opened 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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

email_opened_id = 56 # Integer | 


begin
  result = api_instance.marketing_campaigns_id_emails_opened_email_opened_id_get(id, email_opened_id)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_email_opened_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
email_opened_id Integer

Return type

EmailOpened

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_emails_opened_email_opened_id_patch

EmailOpened marketing_campaigns_id_emails_opened_email_opened_id_patch(id, email_opened_id, operations)

Update Email Opened

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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

email_opened_id = 56 # Integer | 

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


begin
  result = api_instance.marketing_campaigns_id_emails_opened_email_opened_id_patch(id, email_opened_id, operations)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_email_opened_id_patch: #{e}"
end

Parameters

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

Return type

EmailOpened

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_emails_opened_email_opened_id_put

EmailOpened marketing_campaigns_id_emails_opened_email_opened_id_put(id, email_opened_id, email_opened)

Replace Email Opened

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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

email_opened_id = 56 # Integer | 

email_opened = ConnectWise::EmailOpened.new # EmailOpened | 


begin
  result = api_instance.marketing_campaigns_id_emails_opened_email_opened_id_put(id, email_opened_id, email_opened)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_email_opened_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
email_opened_id Integer
email_opened EmailOpened

Return type

EmailOpened

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_emails_opened_get

Array<EmailOpened> marketing_campaigns_id_emails_opened_get(id, opts)

Get Emails Opened

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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

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

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

Parameters

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

Return type

Array<EmailOpened>

Authorization

BasicAuth

HTTP request headers

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

marketing_campaigns_id_emails_opened_post

EmailOpened marketing_campaigns_id_emails_opened_post(id, email_opened)

Create Email Opened

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::CampaignEmailsOpenedApi.new

id = 56 # Integer | 

email_opened = ConnectWise::EmailOpened.new # EmailOpened | 


begin
  result = api_instance.marketing_campaigns_id_emails_opened_post(id, email_opened)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling CampaignEmailsOpenedApi->marketing_campaigns_id_emails_opened_post: #{e}"
end

Parameters

Name Type Description Notes
id Integer
email_opened EmailOpened

Return type

EmailOpened

Authorization

BasicAuth

HTTP request headers

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