Class: KlaviyoAPI::CampaignsApi
- Inherits:
-
Object
- Object
- KlaviyoAPI::CampaignsApi
- Defined in:
- lib/klaviyo-api-sdk/api/campaigns_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#assign_template_to_campaign_message(campaign_message_assign_template_query, opts = {}) ⇒ Hash<String, Object>
(also: #create_campaign_message_assign_template)
Assign Template to Campaign Message Creates a non-reusable version of the template and assigns it to the message.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#assign_template_to_campaign_message_with_http_info(campaign_message_assign_template_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #create_campaign_message_assign_template_with_http_info)
Assign Template to Campaign Message Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#cancel_campaign_send(id, campaign_send_job_partial_update_query, opts = {}) ⇒ nil
(also: #update_campaign_send_job)
Cancel Campaign Send Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
(also: #update_campaign_send_job_with_http_info)
Cancel Campaign Send Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#create_campaign(campaign_create_query, opts = {}) ⇒ Hash<String, Object>
Create Campaign Creates a campaign given a set of parameters, then returns it.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#create_campaign_clone(campaign_clone_query, opts = {}) ⇒ Hash<String, Object>
(also: #clone_campaign)
Create Campaign Clone Clones an existing campaign, returning a new campaign based on the original with a new ID and name.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#create_campaign_clone_with_http_info(campaign_clone_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #clone_campaign_with_http_info)
Create Campaign Clone Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#create_campaign_with_http_info(campaign_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Campaign Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#delete_campaign(id, opts = {}) ⇒ nil
Delete Campaign Delete a campaign with the given campaign ID.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#delete_campaign_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Campaign Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#get_campaign(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Returns a specific campaign based on a required id.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_campaign)
Get Campaign for Campaign Message Return the related campaign
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_campaign_with_http_info)
Get Campaign for Campaign Message Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaign_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_relationships_campaign)
Get Campaign ID for Campaign Message Returns the ID of the related campaign
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_relationships_campaign_with_http_info)
Get Campaign ID for Campaign Message Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Message Returns a specific message based on a required id.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Message Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaign_recipient_estimation(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Recipient Estimation Get the estimated recipient count for a campaign with the provided campaign ID.
-
#get_campaign_recipient_estimation_job(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Recipient Estimation Job Retrieve the status of a recipient estimation job triggered with the ‘Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_recipient_estimation_job_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Recipient Estimation Job Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaign_recipient_estimation_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Recipient Estimation Get the estimated recipient count for a campaign with the provided campaign ID.
-
#get_campaign_send_job(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Send Job Get a campaign send job
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_campaign_send_job_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Send Job Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_campaigns(filter, opts = {}) ⇒ Hash<String, Object>
Get Campaigns Returns some or all campaigns based on filters.
-
#get_campaigns_with_http_info(filter, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaigns Returns some or all campaigns based on filters.
-
#get_image_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_image)
Get Image for Campaign Message Return the related image for a given campaign message
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `images:read`. -
#get_image_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_image_with_http_info)
Get Image for Campaign Message Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `images:read`.
-
#get_image_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_relationships_image)
Get Image ID for Campaign Message Returns the ID of the related image
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `images:read`. -
#get_image_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_relationships_image_with_http_info)
Get Image ID for Campaign Message Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `images:read`.
-
#get_message_ids_for_campaign(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_relationships_campaign_messages, #get_campaign_relationships_messages)
Get Message IDs for Campaign Returns the IDs of all messages associated with the given campaign.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_message_ids_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_relationships_campaign_messages_with_http_info, #get_campaign_relationships_messages_with_http_info)
Get Message IDs for Campaign Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_messages_for_campaign(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_campaign_messages, #get_campaign_messages)
Get Messages for Campaign Return all messages that belong to the given campaign.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`. -
#get_messages_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_campaign_messages_with_http_info, #get_campaign_messages_with_http_info)
Get Messages for Campaign Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`.
-
#get_tag_ids_for_campaign(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_relationships_tags)
Get Tag IDs for Campaign Returns the IDs of all tags associated with the given campaign.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`. -
#get_tag_ids_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_relationships_tags_with_http_info)
Get Tag IDs for Campaign Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`.
-
#get_tags_for_campaign(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_tags)
Get Tags for Campaign Return all tags that belong to the given campaign.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`. -
#get_tags_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_tags_with_http_info)
Get Tags for Campaign Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`.
-
#get_template_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_template)
Get Template for Campaign Message Return the related template
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `templates:read`. -
#get_template_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_template_with_http_info)
Get Template for Campaign Message Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `templates:read`.
-
#get_template_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
(also: #get_campaign_message_relationships_template)
Get Template ID for Campaign Message Returns the ID of the related template
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `templates:read`. -
#get_template_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #get_campaign_message_relationships_template_with_http_info)
Get Template ID for Campaign Message Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `templates:read`.
-
#initialize(api_client = ApiClient.default) ⇒ CampaignsApi
constructor
A new instance of CampaignsApi.
-
#refresh_campaign_recipient_estimation(campaign_recipient_estimation_job_create_query, opts = {}) ⇒ Hash<String, Object>
(also: #create_campaign_recipient_estimation_job)
Refresh Campaign Recipient Estimation Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID.
-
#refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #create_campaign_recipient_estimation_job_with_http_info)
Refresh Campaign Recipient Estimation Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID.
-
#send_campaign(campaign_send_job_create_query, opts = {}) ⇒ Hash<String, Object>
(also: #create_campaign_send_job)
Send Campaign Trigger a campaign to send asynchronously
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#send_campaign_with_http_info(campaign_send_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
(also: #create_campaign_send_job_with_http_info)
Send Campaign Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#update_campaign(id, campaign_partial_update_query, opts = {}) ⇒ Hash<String, Object>
Update Campaign Update a campaign with the given campaign ID.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#update_campaign_message(id, campaign_message_partial_update_query, opts = {}) ⇒ Hash<String, Object>
Update Campaign Message Update a campaign message
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`. -
#update_campaign_message_with_http_info(id, campaign_message_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Campaign Message Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#update_campaign_with_http_info(id, campaign_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Campaign Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`.
-
#update_image_for_campaign_message(id, campaign_message_image_update_query, opts = {}) ⇒ nil
(also: #update_campaign_message_relationships_image)
Update Image for Campaign Message Update a campaign message image
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write` `images:read`. -
#update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
(also: #update_campaign_message_relationships_image_with_http_info)
Update Image for Campaign Message Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write` `images:read`.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CampaignsApi
Returns a new instance of CampaignsApi.
18 19 20 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 18 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
16 17 18 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 16 def api_client @api_client end |
Instance Method Details
#assign_template_to_campaign_message(campaign_message_assign_template_query, opts = {}) ⇒ Hash<String, Object> Also known as: create_campaign_message_assign_template
Assign Template to Campaign Message Creates a non-reusable version of the template and assigns it to the message.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
26 27 28 29 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 26 def (, opts = {}) data, _status_code, _headers = (, opts) data end |
#assign_template_to_campaign_message_with_http_info(campaign_message_assign_template_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: create_campaign_message_assign_template_with_http_info
Assign Template to Campaign Message Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 39 def (, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.assign_template_to_campaign_message ...' end # verify the required parameter 'campaign_message_assign_template_query' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'campaign_message_assign_template_query' when calling CampaignsApi.assign_template_to_campaign_message" end # resource path local_var_path = '/api/campaign-message-assign-template' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body() # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.assign_template_to_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#assign_template_to_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#cancel_campaign_send(id, campaign_send_job_partial_update_query, opts = {}) ⇒ nil Also known as: update_campaign_send_job
Cancel Campaign Send Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
103 104 105 106 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 103 def cancel_campaign_send(id, campaign_send_job_partial_update_query, opts = {}) cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts) nil end |
#cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: update_campaign_send_job_with_http_info
Cancel Campaign Send Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 117 def cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.cancel_campaign_send ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.cancel_campaign_send" end # verify the required parameter 'campaign_send_job_partial_update_query' is set if @api_client.config.client_side_validation && campaign_send_job_partial_update_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_send_job_partial_update_query' when calling CampaignsApi.cancel_campaign_send" end # resource path local_var_path = '/api/campaign-send-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_send_job_partial_update_query) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.cancel_campaign_send", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#cancel_campaign_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_campaign(campaign_create_query, opts = {}) ⇒ Hash<String, Object>
Create Campaign Creates a campaign given a set of parameters, then returns it.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
184 185 186 187 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 184 def create_campaign(campaign_create_query, opts = {}) data, _status_code, _headers = create_campaign_with_http_info(campaign_create_query, opts) data end |
#create_campaign_clone(campaign_clone_query, opts = {}) ⇒ Hash<String, Object> Also known as: clone_campaign
Create Campaign Clone Clones an existing campaign, returning a new campaign based on the original with a new ID and name.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
254 255 256 257 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 254 def create_campaign_clone(campaign_clone_query, opts = {}) data, _status_code, _headers = create_campaign_clone_with_http_info(campaign_clone_query, opts) data end |
#create_campaign_clone_with_http_info(campaign_clone_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: clone_campaign_with_http_info
Create Campaign Clone Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 267 def create_campaign_clone_with_http_info(campaign_clone_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.create_campaign_clone ...' end # verify the required parameter 'campaign_clone_query' is set if @api_client.config.client_side_validation && campaign_clone_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_clone_query' when calling CampaignsApi.create_campaign_clone" end # resource path local_var_path = '/api/campaign-clone' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_clone_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.create_campaign_clone", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#create_campaign_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_campaign_with_http_info(campaign_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Campaign Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 194 def create_campaign_with_http_info(campaign_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.create_campaign ...' end # verify the required parameter 'campaign_create_query' is set if @api_client.config.client_side_validation && campaign_create_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_create_query' when calling CampaignsApi.create_campaign" end # resource path local_var_path = '/api/campaigns' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.create_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#create_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_campaign(id, opts = {}) ⇒ nil
Delete Campaign Delete a campaign with the given campaign ID.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
330 331 332 333 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 330 def delete_campaign(id, opts = {}) delete_campaign_with_http_info(id, opts) nil end |
#delete_campaign_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Campaign Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 340 def delete_campaign_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.delete_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.delete_campaign" end # resource path local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.delete_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Returns a specific campaign based on a required id.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
399 400 401 402 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 399 def get_campaign(id, opts = {}) data, _status_code, _headers = get_campaign_with_http_info(id, opts) data end |
#get_campaign_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_campaign
Get Campaign for Campaign Message Return the related campaign
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
489 490 491 492 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 489 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_campaign_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_campaign_with_http_info
Get Campaign for Campaign Message Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 503 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_for_campaign_message" end allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"] if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-messages/{id}/campaign'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_relationships_campaign
Get Campaign ID for Campaign Message Returns the ID of the related campaign
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
566 567 568 569 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 566 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_campaign_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_relationships_campaign_with_http_info
Get Campaign ID for Campaign Message Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 579 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_id_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_id_for_campaign_message" end # resource path local_var_path = '/api/campaign-messages/{id}/relationships/campaign'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_id_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_message(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Message Returns a specific message based on a required id.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
642 643 644 645 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 642 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Message Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 657 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message" end allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.kv_pairs", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.badge.badge_options", "definition.options.badge.badge_options.badge_config", "definition.options.badge.badge_options.value", "definition.options.badge.badge_options.set_from_property", "definition.options.play_sound", "send_times", "created_at", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}" end allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"] if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}" end allowable_values = ["name", "editor_type", "html", "text", "amp", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}" end allowable_values = ["campaign", "image", "template"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil? query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil? query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil? query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_recipient_estimation(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Recipient Estimation Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the ‘Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` Scopes: `campaigns:read`
738 739 740 741 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 738 def get_campaign_recipient_estimation(id, opts = {}) data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts) data end |
#get_campaign_recipient_estimation_job(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Recipient Estimation Job Retrieve the status of a recipient estimation job triggered with the ‘Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` Scopes: `campaigns:read`
810 811 812 813 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 810 def get_campaign_recipient_estimation_job(id, opts = {}) data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts) data end |
#get_campaign_recipient_estimation_job_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Recipient Estimation Job Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 821 def get_campaign_recipient_estimation_job_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_recipient_estimation_job ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_recipient_estimation_job" end allowable_values = ["status"] if @api_client.config.client_side_validation && opts[:'fields_campaign_recipient_estimation_job'] && !opts[:'fields_campaign_recipient_estimation_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_recipient_estimation_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-recipient-estimation-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-recipient-estimation-job]'] = @api_client.build_collection_param(opts[:'fields_campaign_recipient_estimation_job'], :csv) if !opts[:'fields_campaign_recipient_estimation_job'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_recipient_estimation_job", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_recipient_estimation_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_recipient_estimation_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Recipient Estimation Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 749 def get_campaign_recipient_estimation_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_recipient_estimation ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_recipient_estimation" end allowable_values = ["estimated_recipient_count"] if @api_client.config.client_side_validation && opts[:'fields_campaign_recipient_estimation'] && !opts[:'fields_campaign_recipient_estimation'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_recipient_estimation\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-recipient-estimations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-recipient-estimation]'] = @api_client.build_collection_param(opts[:'fields_campaign_recipient_estimation'], :csv) if !opts[:'fields_campaign_recipient_estimation'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_recipient_estimation", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_recipient_estimation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_send_job(id, opts = {}) ⇒ Hash<String, Object>
Get Campaign Send Job Get a campaign send job
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
882 883 884 885 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 882 def get_campaign_send_job(id, opts = {}) data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts) data end |
#get_campaign_send_job_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Send Job Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 893 def get_campaign_send_job_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_send_job ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_send_job" end allowable_values = ["status"] if @api_client.config.client_side_validation && opts[:'fields_campaign_send_job'] && !opts[:'fields_campaign_send_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_send_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-send-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-send-job]'] = @api_client.build_collection_param(opts[:'fields_campaign_send_job'], :csv) if !opts[:'fields_campaign_send_job'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign_send_job", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_send_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaign Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 413 def get_campaign_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign" end allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.kv_pairs", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.badge.badge_options", "definition.options.badge.badge_options.badge_config", "definition.options.badge.badge_options.value", "definition.options.badge.badge_options.set_from_property", "definition.options.play_sound", "send_times", "created_at", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}" end allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"] if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end allowable_values = ["campaign-messages", "tags"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil? query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil? query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaigns(filter, opts = {}) ⇒ Hash<String, Object>
Get Campaigns Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: ‘?filter=equals(messages.channel,’email’)‘ to list email campaigns, or `?filter=equals(messages.channel,’sms’)‘ to list SMS campaigns. `?filter=equals(messages.channel,’mobile_push’)‘ to list mobile push campaigns.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` Scopes: `campaigns:read`
959 960 961 962 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 959 def get_campaigns(filter, opts = {}) data, _status_code, _headers = get_campaigns_with_http_info(filter, opts) data end |
#get_campaigns_with_http_info(filter, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Campaigns Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 975 def get_campaigns_with_http_info(filter, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...' end # verify the required parameter 'filter' is set if @api_client.config.client_side_validation && filter.nil? fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns" end allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.kv_pairs", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.badge.badge_options", "definition.options.badge.badge_options.badge_config", "definition.options.badge.badge_options.value", "definition.options.badge.badge_options.set_from_property", "definition.options.play_sound", "send_times", "created_at", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}" end allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"] if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end allowable_values = ["campaign-messages", "tags"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/campaigns' # query parameters query_params = opts[:query_params] || {} query_params[:'filter'] = filter query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil? query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil? query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_campaigns", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_image_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_image
Get Image for Campaign Message Return the related image for a given campaign message
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `images:read`
1058 1059 1060 1061 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1058 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_image_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_image_with_http_info
Get Image for Campaign Message Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `images:read`
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1072 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_for_campaign_message" end allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-messages/{id}/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_image_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_image_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_relationships_image
Get Image ID for Campaign Message Returns the ID of the related image
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `images:read`
1135 1136 1137 1138 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1135 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_image_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_relationships_image_with_http_info
Get Image ID for Campaign Message Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `images:read`
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1148 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_id_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_id_for_campaign_message" end # resource path local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_image_id_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_image_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_message_ids_for_campaign(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_relationships_campaign_messages, get_campaign_relationships_messages
Get Message IDs for Campaign Returns the IDs of all messages associated with the given campaign.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
1206 1207 1208 1209 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1206 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_message_ids_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_relationships_campaign_messages_with_http_info, get_campaign_relationships_messages_with_http_info
Get Message IDs for Campaign Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1222 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_message_ids_for_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_message_ids_for_campaign" end # resource path local_var_path = '/api/campaigns/{id}/relationships/campaign-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_message_ids_for_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_message_ids_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_messages_for_campaign(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_campaign_messages, get_campaign_messages
Get Messages for Campaign Return all messages that belong to the given campaign.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read`
1288 1289 1290 1291 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1288 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_messages_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_campaign_messages_with_http_info, get_campaign_messages_with_http_info
Get Messages for Campaign Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read`
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1309 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_messages_for_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_messages_for_campaign" end allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.kv_pairs", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.badge.badge_options", "definition.options.badge.badge_options.badge_config", "definition.options.badge.badge_options.value", "definition.options.badge.badge_options.set_from_property", "definition.options.play_sound", "send_times", "created_at", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}" end allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"] if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}" end allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"] if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}" end allowable_values = ["name", "editor_type", "html", "text", "amp", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}" end allowable_values = ["campaign", "image", "template"] if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaigns/{id}/campaign-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil? query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil? query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil? query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil? query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_messages_for_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_messages_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_ids_for_campaign(id, opts = {}) ⇒ Hash<String, Object> Also known as:
Get Tag IDs for Campaign Returns the IDs of all tags associated with the given campaign.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1395 1396 1397 1398 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1395 def get_tag_ids_for_campaign(id, opts = {}) data, _status_code, _headers = get_tag_ids_for_campaign_with_http_info(id, opts) data end |
#get_tag_ids_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as:
Get Tag IDs for Campaign Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1408 def get_tag_ids_for_campaign_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_tag_ids_for_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_tag_ids_for_campaign" end # resource path local_var_path = '/api/campaigns/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_tag_ids_for_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_tag_ids_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tags_for_campaign(id, opts = {}) ⇒ Hash<String, Object> Also known as:
Get Tags for Campaign Return all tags that belong to the given campaign.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1467 1468 1469 1470 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1467 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_tags_for_campaign_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as:
Get Tags for Campaign Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1481 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_tags_for_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_tags_for_campaign" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaigns/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_tags_for_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_tags_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_template
Get Template for Campaign Message Return the related template
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `templates:read`
1545 1546 1547 1548 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1545 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_template_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_template_with_http_info
Get Template for Campaign Message Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `templates:read`
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1559 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_template_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_template_for_campaign_message" end allowable_values = ["name", "editor_type", "html", "text", "amp", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/campaign-messages/{id}/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_template_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_template_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template_id_for_campaign_message(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_campaign_message_relationships_template
Get Template ID for Campaign Message Returns the ID of the related template
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:read` `templates:read`
1622 1623 1624 1625 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1622 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_template_id_for_campaign_message_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_campaign_message_relationships_template_with_http_info
Get Template ID for Campaign Message Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:read` `templates:read`
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1635 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.get_template_id_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_template_id_for_campaign_message" end # resource path local_var_path = '/api/campaign-messages/{id}/relationships/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.get_template_id_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#get_template_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#refresh_campaign_recipient_estimation(campaign_recipient_estimation_job_create_query, opts = {}) ⇒ Hash<String, Object> Also known as: create_campaign_recipient_estimation_job
Refresh Campaign Recipient Estimation Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the ‘Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` Scopes: `campaigns:write`
1693 1694 1695 1696 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1693 def refresh_campaign_recipient_estimation(campaign_recipient_estimation_job_create_query, opts = {}) data, _status_code, _headers = refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts) data end |
#refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: create_campaign_recipient_estimation_job_with_http_info
Refresh Campaign Recipient Estimation Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1706 def refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.refresh_campaign_recipient_estimation ...' end # verify the required parameter 'campaign_recipient_estimation_job_create_query' is set if @api_client.config.client_side_validation && campaign_recipient_estimation_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_recipient_estimation_job_create_query' when calling CampaignsApi.refresh_campaign_recipient_estimation" end # resource path local_var_path = '/api/campaign-recipient-estimation-jobs' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_recipient_estimation_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.refresh_campaign_recipient_estimation", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#refresh_campaign_recipient_estimation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_campaign(campaign_send_job_create_query, opts = {}) ⇒ Hash<String, Object> Also known as: create_campaign_send_job
Send Campaign Trigger a campaign to send asynchronously
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
1769 1770 1771 1772 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1769 def send_campaign(campaign_send_job_create_query, opts = {}) data, _status_code, _headers = send_campaign_with_http_info(campaign_send_job_create_query, opts) data end |
#send_campaign_with_http_info(campaign_send_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: create_campaign_send_job_with_http_info
Send Campaign Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1782 def send_campaign_with_http_info(campaign_send_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.send_campaign ...' end # verify the required parameter 'campaign_send_job_create_query' is set if @api_client.config.client_side_validation && campaign_send_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_send_job_create_query' when calling CampaignsApi.send_campaign" end # resource path local_var_path = '/api/campaign-send-jobs' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_send_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.send_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#send_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_campaign(id, campaign_partial_update_query, opts = {}) ⇒ Hash<String, Object>
Update Campaign Update a campaign with the given campaign ID.
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
1846 1847 1848 1849 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1846 def update_campaign(id, campaign_partial_update_query, opts = {}) data, _status_code, _headers = update_campaign_with_http_info(id, campaign_partial_update_query, opts) data end |
#update_campaign_message(id, campaign_message_partial_update_query, opts = {}) ⇒ Hash<String, Object>
Update Campaign Message Update a campaign message
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write`
1922 1923 1924 1925 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1922 def (id, , opts = {}) data, _status_code, _headers = (id, , opts) data end |
#update_campaign_message_with_http_info(id, campaign_message_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Campaign Message Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1933 def (id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.update_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_campaign_message" end # verify the required parameter 'campaign_message_partial_update_query' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'campaign_message_partial_update_query' when calling CampaignsApi.update_campaign_message" end # resource path local_var_path = '/api/campaign-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body() # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.update_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#update_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_campaign_with_http_info(id, campaign_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Campaign Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write`
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1857 def update_campaign_with_http_info(id, campaign_partial_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.update_campaign ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_campaign" end # verify the required parameter 'campaign_partial_update_query' is set if @api_client.config.client_side_validation && campaign_partial_update_query.nil? fail ArgumentError, "Missing the required parameter 'campaign_partial_update_query' when calling CampaignsApi.update_campaign" end # resource path local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_partial_update_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.update_campaign", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#update_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_image_for_campaign_message(id, campaign_message_image_update_query, opts = {}) ⇒ nil Also known as: update_campaign_message_relationships_image
Update Image for Campaign Message Update a campaign message image
*Rate limits*:
Burst: ‘10/s`
Steady: `150/m` Scopes: `campaigns:write` `images:read`
1998 1999 2000 2001 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 1998 def (id, , opts = {}) (id, , opts) nil end |
#update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: update_campaign_message_relationships_image_with_http_info
Update Image for Campaign Message Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` Scopes: `campaigns:write` `images:read`
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 |
# File 'lib/klaviyo-api-sdk/api/campaigns_api.rb', line 2012 def (id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CampaignsApi.update_image_for_campaign_message ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_image_for_campaign_message" end # verify the required parameter 'campaign_message_image_update_query' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'campaign_message_image_update_query' when calling CampaignsApi.update_image_for_campaign_message" end # resource path local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body() # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth'] = opts.merge( :operation => :"CampaignsApi.update_image_for_campaign_message", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CampaignsApi#update_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |