struct Mailjet::Campaign
- Mailjet::Campaign
- Mailjet::Resource
- Struct
- Value
- Object
Overview
When you send a campaign draft, a new campaign object is automatically created. Use the resources below to retrieve information about campaigns, mark selected campaigns as starred or delete them.
https://dev.mailjet.com/email/reference/campaigns/sent-campaigns/
Defined in:
mailjet/resources/campaign.crClass Method Summary
-
.all(query : Hash | NamedTuple = Hash(String, String).new, params : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
Find all campaigns
-
.find(params : Hash | NamedTuple = Hash(String, String).new, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
Find a campaign
-
.find(id : ResourceId, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
Find a campaign
-
.update(params : Hash | NamedTuple = Hash(String, String).new, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
Update a campaign
-
.update(id : ResourceId, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
Update a campaign
Instance methods inherited from struct Mailjet::Resource
initialize
initialize
Constructor methods inherited from struct Mailjet::Resource
new
new
Class Method Detail
def self.all(query : Hash | NamedTuple = Hash(String, String).new, params : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
#
Find all campaigns
response = Mailjet::Campaign.all
campaigns = response.data
def self.find(params : Hash | NamedTuple = Hash(String, String).new, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
#
Find a campaign
campaign = Mailjet::Campaign.find(1234567890987654400)
def self.find(id : ResourceId, query : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
#
Find a campaign
campaign = Mailjet::Campaign.find(1234567890987654400)
def self.update(params : Hash | NamedTuple = Hash(String, String).new, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
#
Update a campaign
campaign = Mailjet::Campaign.update(1234567890987654400, {
is_deleted: true,
is_starred: false,
})
def self.update(id : ResourceId, payload : Hash | NamedTuple = Hash(String, String).new, client : Client = Client.new)
#
Update a campaign
campaign = Mailjet::Campaign.update(1234567890987654400, {
is_deleted: true,
is_starred: false,
})