Class: KlaviyoAPI::TagsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/api/tags_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TagsApi

Returns a new instance of TagsApi.



19
20
21
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_tag(tag_create_query, opts = {}) ⇒ Hash<String, Object>

Create Tag Create a tag. An account cannot have more than 500 unique tags. A tag belongs to a single tag group. If the ‘tag_group_id` is not specified, the tag is added to the account’s default tag group.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • tag_create_query (TagCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 27

def create_tag(tag_create_query, opts = {})
  data, _status_code, _headers = create_tag_with_http_info(tag_create_query, opts)
  data
end

#create_tag_group(tag_group_create_query, opts = {}) ⇒ Hash<String, Object>

Create Tag Group Create a tag group. An account cannot have more than 50 unique tag groups. If ‘exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • tag_group_create_query (TagGroupCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


97
98
99
100
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 97

def create_tag_group(tag_group_create_query, opts = {})
  data, _status_code, _headers = create_tag_group_with_http_info(tag_group_create_query, opts)
  data
end

#create_tag_group_with_http_info(tag_group_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create Tag Group Create a tag group. An account cannot have more than 50 unique tag groups. If &#x60;exclusive&#x60; is not specified &#x60;true&#x60; or &#x60;false&#x60;, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • tag_group_create_query (TagGroupCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
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
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 107

def create_tag_group_with_http_info(tag_group_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_group ...'
  end
  # verify the required parameter 'tag_group_create_query' is set
  if @api_client.config.client_side_validation && tag_group_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'tag_group_create_query' when calling TagsApi.create_tag_group"
  end
  # resource path
  local_var_path = '/api/tag-groups'

  # 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-01-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(tag_group_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']

  new_options = opts.merge(
    :operation => :"TagsApi.create_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#create_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tag_with_http_info(tag_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create Tag Create a tag. An account cannot have more than 500 unique tags. A tag belongs to a single tag group. If the &#x60;tag_group_id&#x60; is not specified, the tag is added to the account&#39;s default tag group.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • tag_create_query (TagCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



37
38
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
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 37

def create_tag_with_http_info(tag_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.create_tag ...'
  end
  # verify the required parameter 'tag_create_query' is set
  if @api_client.config.client_side_validation && tag_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'tag_create_query' when calling TagsApi.create_tag"
  end
  # resource path
  local_var_path = '/api/tags'

  # 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-01-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(tag_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']

  new_options = opts.merge(
    :operation => :"TagsApi.create_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag(id, opts = {}) ⇒ nil

Delete Tag Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


167
168
169
170
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 167

def delete_tag(id, opts = {})
  delete_tag_with_http_info(id, opts)
  nil
end

#delete_tag_group(id, opts = {}) ⇒ Hash<String, Object>

Delete Tag Group Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


232
233
234
235
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 232

def delete_tag_group(id, opts = {})
  data, _status_code, _headers = delete_tag_group_with_http_info(id, opts)
  data
end

#delete_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Delete Tag Group Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 242

def delete_tag_group_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...'
  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 TagsApi.delete_tag_group"
  end
  # resource path
  local_var_path = '/api/tag-groups/{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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.delete_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Tag Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
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
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 177

def delete_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
  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 TagsApi.delete_tag"
  end
  # resource path
  local_var_path = '/api/tags/{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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.delete_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaign_ids_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_relationships_campaigns

Get Campaign IDs for Tag Returns the IDs of all campaigns associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


297
298
299
300
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 297

def get_campaign_ids_for_tag(id, opts = {})
  data, _status_code, _headers = get_campaign_ids_for_tag_with_http_info(id, opts)
  data
end

#get_campaign_ids_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_relationships_campaigns_with_http_info

Get Campaign IDs for Tag Returns the IDs of all campaigns associated with the given tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;campaigns:read&#x60; &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 310

def get_campaign_ids_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_campaign_ids_for_tag ...'
  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 TagsApi.get_campaign_ids_for_tag"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/campaigns'.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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_campaign_ids_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_campaign_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flow_ids_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_relationships_flows

Get Flow IDs for Tag Returns the IDs of all flows associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:read` `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


368
369
370
371
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 368

def get_flow_ids_for_tag(id, opts = {})
  data, _status_code, _headers = get_flow_ids_for_tag_with_http_info(id, opts)
  data
end

#get_flow_ids_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_relationships_flows_with_http_info

Get Flow IDs for Tag Returns the IDs of all flows associated with the given tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;flows:read&#x60; &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 381

def get_flow_ids_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_flow_ids_for_tag ...'
  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 TagsApi.get_flow_ids_for_tag"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/flows'.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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_flow_ids_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_flow_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_list_ids_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_relationships_lists

Get List IDs for Tag Returns the IDs of all lists associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `lists:read` `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


439
440
441
442
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 439

def get_list_ids_for_tag(id, opts = {})
  data, _status_code, _headers = get_list_ids_for_tag_with_http_info(id, opts)
  data
end

#get_list_ids_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_relationships_lists_with_http_info

Get List IDs for Tag Returns the IDs of all lists associated with the given tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;lists:read&#x60; &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 452

def get_list_ids_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_list_ids_for_tag ...'
  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 TagsApi.get_list_ids_for_tag"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/lists'.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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_list_ids_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_list_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_segment_ids_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_relationships_segments

Get Segment IDs for Tag Returns the IDs of all segments associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:read` `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


510
511
512
513
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 510

def get_segment_ids_for_tag(id, opts = {})
  data, _status_code, _headers = get_segment_ids_for_tag_with_http_info(id, opts)
  data
end

#get_segment_ids_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_relationships_segments_with_http_info

Get Segment IDs for Tag Returns the IDs of all segments associated with the given tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;segments:read&#x60; &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 523

def get_segment_ids_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_segment_ids_for_tag ...'
  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 TagsApi.get_segment_ids_for_tag"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/segments'.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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_segment_ids_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_segment_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag(id, opts = {}) ⇒ Hash<String, Object>

Get Tag Retrieve the tag with the given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


584
585
586
587
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 584

def get_tag(id, opts = {})
  data, _status_code, _headers = get_tag_with_http_info(id, opts)
  data
end

#get_tag_group(id, opts = {}) ⇒ Hash<String, Object>

Get Tag Group Retrieve the tag group with the given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


668
669
670
671
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 668

def get_tag_group(id, opts = {})
  data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
  data
end

#get_tag_group_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_tag_group, get_group_for_tag

Get Tag Group for Tag Returns the tag group resource for a given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


740
741
742
743
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 740

def get_tag_group_for_tag(id, opts = {})
  data, _status_code, _headers = get_tag_group_for_tag_with_http_info(id, opts)
  data
end

#get_tag_group_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_tag_group_with_http_info, get_group_for_tag_with_http_info

Get Tag Group for Tag Returns the tag group resource for a given tag ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
803
804
805
806
807
808
809
810
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 757

def get_tag_group_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_for_tag ...'
  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 TagsApi.get_tag_group_for_tag"
  end
  allowable_values = ["name", "exclusive", "default"]
  if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/tags/{id}/tag-group'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_group_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag_group_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_group_id_for_tag(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_relationships_tag_group, get_group_id_for_tag, get_tag_relationships_group

Get Tag Group ID for Tag Returns the id of the tag group related to the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


823
824
825
826
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 823

def get_tag_group_id_for_tag(id, opts = {})
  data, _status_code, _headers = get_tag_group_id_for_tag_with_http_info(id, opts)
  data
end

#get_tag_group_id_for_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_relationships_tag_group_with_http_info, get_group_id_for_tag_with_http_info, get_tag_relationships_group_with_http_info

Get Tag Group ID for Tag Returns the id of the tag group related to the given tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 842

def get_tag_group_id_for_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_id_for_tag ...'
  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 TagsApi.get_tag_group_id_for_tag"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/tag-group'.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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_group_id_for_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag_group_id_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Tag Group Retrieve the tag group with the given tag group ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
731
732
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 679

def get_tag_group_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group ...'
  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 TagsApi.get_tag_group"
  end
  allowable_values = ["name", "exclusive", "default"]
  if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_groups(opts = {}) ⇒ Hash<String, Object>

Get Tag Groups List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by ‘name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


909
910
911
912
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 909

def get_tag_groups(opts = {})
  data, _status_code, _headers = get_tag_groups_with_http_info(opts)
  data
end

#get_tag_groups_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Tag Groups List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by &#x60;name&#x60;, &#x60;exclusive&#x60;, and &#x60;default&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 922

def get_tag_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...'
  end
  allowable_values = ["name", "exclusive", "default"]
  if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
  end
  allowable_values = ["id", "-id", "name", "-name"]
  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/tag-groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_groups",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_ids_for_tag_group(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_group_relationships_tags

Get Tag IDs for Tag Group Returns the tag IDs of all tags inside the given tag group.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


985
986
987
988
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 985

def get_tag_ids_for_tag_group(id, opts = {})
  data, _status_code, _headers = get_tag_ids_for_tag_group_with_http_info(id, opts)
  data
end

#get_tag_ids_for_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_group_relationships_tags_with_http_info

Get Tag IDs for Tag Group Returns the tag IDs of all tags inside the given tag group.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 998

def get_tag_ids_for_tag_group_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_ids_for_tag_group ...'
  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 TagsApi.get_tag_ids_for_tag_group"
  end
  # resource path
  local_var_path = '/api/tag-groups/{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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_ids_for_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag_ids_for_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Tag Retrieve the tag with the given tag ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 597

def get_tag_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...'
  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 TagsApi.get_tag"
  end
  allowable_values = ["name", "exclusive", "default"]
  if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_tag_group\", 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 = ["tag-group"]
  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/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tags(opts = {}) ⇒ Hash<String, Object>

Get Tags List all tags in an account. Tags can be filtered by ‘name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1061
1062
1063
1064
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1061

def get_tags(opts = {})
  data, _status_code, _headers = get_tags_with_http_info(opts)
  data
end

#get_tags_for_tag_group(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_tag_group_tags

Get Tags for Tag Group Return the tags for a given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1150
1151
1152
1153
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1150

def get_tags_for_tag_group(id, opts = {})
  data, _status_code, _headers = get_tags_for_tag_group_with_http_info(id, opts)
  data
end

#get_tags_for_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_tag_group_tags_with_http_info

Get Tags for Tag Group Return the tags for a given tag group ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • id (String) —

    The Tag Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1164

def get_tags_for_tag_group_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tags_for_tag_group ...'
  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 TagsApi.get_tags_for_tag_group"
  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/tag-groups/{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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tags_for_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tags_for_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tags_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Tags List all tags in an account. Tags can be filtered by &#x60;name&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1076

def get_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
  end
  allowable_values = ["name", "exclusive", "default"]
  if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_tag_group\", 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 = ["tag-group"]
  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 = ["id", "-id", "name", "-name"]
  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/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
  query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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-01-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']

  new_options = opts.merge(
    :operation => :"TagsApi.get_tags",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#get_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_tag_from_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil Also known as: delete_tag_relationships_campaigns, remove_campaigns_from_tag

Remove Tag from Campaigns Remove a tag’s association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_campaign_op (TagCampaignOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1228
1229
1230
1231
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1228

def remove_tag_from_campaigns(id, tag_campaign_op, opts = {})
  remove_tag_from_campaigns_with_http_info(id, tag_campaign_op, opts)
  nil
end

#remove_tag_from_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_tag_relationships_campaigns_with_http_info, remove_campaigns_from_tag_with_http_info

Remove Tag from Campaigns Remove a tag&#39;s association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;campaigns:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_campaign_op (TagCampaignOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1245

def remove_tag_from_campaigns_with_http_info(id, tag_campaign_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_campaigns ...'
  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 TagsApi.remove_tag_from_campaigns"
  end
  # verify the required parameter 'tag_campaign_op' is set
  if @api_client.config.client_side_validation && tag_campaign_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.remove_tag_from_campaigns"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/campaigns'.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-01-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(tag_campaign_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.remove_tag_from_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#remove_tag_from_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_tag_from_flows(id, tag_flow_op, opts = {}) ⇒ nil Also known as: delete_tag_relationships_flows, remove_flows_from_tag

Remove Tag from Flows Remove a tag’s association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_flow_op (TagFlowOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1316
1317
1318
1319
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1316

def remove_tag_from_flows(id, tag_flow_op, opts = {})
  remove_tag_from_flows_with_http_info(id, tag_flow_op, opts)
  nil
end

#remove_tag_from_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_tag_relationships_flows_with_http_info, remove_flows_from_tag_with_http_info

Remove Tag from Flows Remove a tag&#39;s association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;flows:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_flow_op (TagFlowOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1333

def remove_tag_from_flows_with_http_info(id, tag_flow_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_flows ...'
  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 TagsApi.remove_tag_from_flows"
  end
  # verify the required parameter 'tag_flow_op' is set
  if @api_client.config.client_side_validation && tag_flow_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.remove_tag_from_flows"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/flows'.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-01-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(tag_flow_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.remove_tag_from_flows",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#remove_tag_from_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_tag_from_lists(id, tag_list_op, opts = {}) ⇒ nil Also known as: delete_tag_relationships_lists, remove_lists_from_tag

Remove Tag from Lists Remove a tag’s association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `lists:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_list_op (TagListOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1404
1405
1406
1407
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1404

def remove_tag_from_lists(id, tag_list_op, opts = {})
  remove_tag_from_lists_with_http_info(id, tag_list_op, opts)
  nil
end

#remove_tag_from_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_tag_relationships_lists_with_http_info, remove_lists_from_tag_with_http_info

Remove Tag from Lists Remove a tag&#39;s association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;lists:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_list_op (TagListOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1421

def remove_tag_from_lists_with_http_info(id, tag_list_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_lists ...'
  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 TagsApi.remove_tag_from_lists"
  end
  # verify the required parameter 'tag_list_op' is set
  if @api_client.config.client_side_validation && tag_list_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.remove_tag_from_lists"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/lists'.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-01-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(tag_list_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.remove_tag_from_lists",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#remove_tag_from_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_tag_from_segments(id, tag_segment_op, opts = {}) ⇒ nil Also known as: delete_tag_relationships_segments, remove_segments_from_tag

Remove Tag from Segments Remove a tag’s association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_segment_op (TagSegmentOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1492
1493
1494
1495
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1492

def remove_tag_from_segments(id, tag_segment_op, opts = {})
  remove_tag_from_segments_with_http_info(id, tag_segment_op, opts)
  nil
end

#remove_tag_from_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_tag_relationships_segments_with_http_info, remove_segments_from_tag_with_http_info

Remove Tag from Segments Remove a tag&#39;s association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;segments:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_segment_op (TagSegmentOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1509

def remove_tag_from_segments_with_http_info(id, tag_segment_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_segments ...'
  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 TagsApi.remove_tag_from_segments"
  end
  # verify the required parameter 'tag_segment_op' is set
  if @api_client.config.client_side_validation && tag_segment_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.remove_tag_from_segments"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/segments'.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-01-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(tag_segment_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.remove_tag_from_segments",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#remove_tag_from_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tag_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil Also known as: create_tag_relationships_campaign, add_campaigns_to_tag, create_tag_relationships_campaigns

Tag Campaigns Associate a tag with one or more campaigns. Any campaign cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_campaign_op (TagCampaignOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1580
1581
1582
1583
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1580

def tag_campaigns(id, tag_campaign_op, opts = {})
  tag_campaigns_with_http_info(id, tag_campaign_op, opts)
  nil
end

#tag_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_tag_relationships_campaign_with_http_info, add_campaigns_to_tag_with_http_info, create_tag_relationships_campaigns_with_http_info

Tag Campaigns Associate a tag with one or more campaigns. Any campaign cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;campaigns:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_campaign_op (TagCampaignOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1600

def tag_campaigns_with_http_info(id, tag_campaign_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tag_campaigns ...'
  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 TagsApi.tag_campaigns"
  end
  # verify the required parameter 'tag_campaign_op' is set
  if @api_client.config.client_side_validation && tag_campaign_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.tag_campaigns"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/campaigns'.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-01-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(tag_campaign_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.tag_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#tag_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tag_flows(id, tag_flow_op, opts = {}) ⇒ nil Also known as: create_tag_relationships_flow, add_flows_to_tag, create_tag_relationships_flows

Tag Flows Associate a tag with one or more flows. Any flow cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_flow_op (TagFlowOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1674
1675
1676
1677
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1674

def tag_flows(id, tag_flow_op, opts = {})
  tag_flows_with_http_info(id, tag_flow_op, opts)
  nil
end

#tag_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_tag_relationships_flow_with_http_info, add_flows_to_tag_with_http_info, create_tag_relationships_flows_with_http_info

Tag Flows Associate a tag with one or more flows. Any flow cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;flows:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_flow_op (TagFlowOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
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
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1694

def tag_flows_with_http_info(id, tag_flow_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tag_flows ...'
  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 TagsApi.tag_flows"
  end
  # verify the required parameter 'tag_flow_op' is set
  if @api_client.config.client_side_validation && tag_flow_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.tag_flows"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/flows'.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-01-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(tag_flow_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.tag_flows",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#tag_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tag_lists(id, tag_list_op, opts = {}) ⇒ nil Also known as: create_tag_relationships_list, add_lists_to_tag, create_tag_relationships_lists

Tag Lists Associate a tag with one or more lists. Any list cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `lists:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_list_op (TagListOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1768
1769
1770
1771
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1768

def tag_lists(id, tag_list_op, opts = {})
  tag_lists_with_http_info(id, tag_list_op, opts)
  nil
end

#tag_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_tag_relationships_list_with_http_info, add_lists_to_tag_with_http_info, create_tag_relationships_lists_with_http_info

Tag Lists Associate a tag with one or more lists. Any list cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;lists:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_list_op (TagListOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1788

def tag_lists_with_http_info(id, tag_list_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tag_lists ...'
  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 TagsApi.tag_lists"
  end
  # verify the required parameter 'tag_list_op' is set
  if @api_client.config.client_side_validation && tag_list_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.tag_lists"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/lists'.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-01-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(tag_list_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.tag_lists",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#tag_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#tag_segments(id, tag_segment_op, opts = {}) ⇒ nil Also known as: create_tag_relationships_segment, add_segments_to_tag, create_tag_relationships_segments

Tag Segments Associate a tag with one or more segments. Any segment cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:write` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_segment_op (TagSegmentOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1862
1863
1864
1865
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1862

def tag_segments(id, tag_segment_op, opts = {})
  tag_segments_with_http_info(id, tag_segment_op, opts)
  nil
end

#tag_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_tag_relationships_segment_with_http_info, add_segments_to_tag_with_http_info, create_tag_relationships_segments_with_http_info

Tag Segments Associate a tag with one or more segments. Any segment cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;segments:write&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_segment_op (TagSegmentOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1882

def tag_segments_with_http_info(id, tag_segment_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.tag_segments ...'
  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 TagsApi.tag_segments"
  end
  # verify the required parameter 'tag_segment_op' is set
  if @api_client.config.client_side_validation && tag_segment_op.nil?
    fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.tag_segments"
  end
  # resource path
  local_var_path = '/api/tags/{id}/relationships/segments'.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-01-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(tag_segment_op)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.tag_segments",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#tag_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag(id, tag_update_query, opts = {}) ⇒ nil

Update Tag Update the tag with the given tag ID. Only a tag’s ‘name` can be changed. A tag cannot be moved from one tag group to another.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • id (String) —

    The Tag ID

  • tag_update_query (TagUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1956
1957
1958
1959
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1956

def update_tag(id, tag_update_query, opts = {})
  update_tag_with_http_info(id, tag_update_query, opts)
  nil
end

#update_tag_group(id, tag_group_update_query, opts = {}) ⇒ Hash<String, Object>

Update Tag Group Update the tag group with the given tag group ID. Only a tag group’s ‘name` can be changed. A tag group’s ‘exclusive` or `default` value cannot be changed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`

Parameters:

  • id (String) —

    The Tag Group ID

  • tag_group_update_query (TagGroupUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


2032
2033
2034
2035
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 2032

def update_tag_group(id, tag_group_update_query, opts = {})
  data, _status_code, _headers = update_tag_group_with_http_info(id, tag_group_update_query, opts)
  data
end

#update_tag_group_with_http_info(id, tag_group_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Update Tag Group Update the tag group with the given tag group ID. Only a tag group&#39;s &#x60;name&#x60; can be changed. A tag group&#39;s &#x60;exclusive&#x60; or &#x60;default&#x60; value cannot be changed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag Group ID

  • tag_group_update_query (TagGroupUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 2043

def update_tag_group_with_http_info(id, tag_group_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.update_tag_group ...'
  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 TagsApi.update_tag_group"
  end
  # verify the required parameter 'tag_group_update_query' is set
  if @api_client.config.client_side_validation && tag_group_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'tag_group_update_query' when calling TagsApi.update_tag_group"
  end
  # resource path
  local_var_path = '/api/tag-groups/{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-01-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(tag_group_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']

  new_options = opts.merge(
    :operation => :"TagsApi.update_tag_group",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#update_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag_with_http_info(id, tag_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Tag Update the tag with the given tag ID. Only a tag&#39;s &#x60;name&#x60; can be changed. A tag cannot be moved from one tag group to another.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;tags:read&#x60; &#x60;tags:write&#x60;

Parameters:

  • id (String) —

    The Tag ID

  • tag_update_query (TagUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1967

def update_tag_with_http_info(id, tag_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
  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 TagsApi.update_tag"
  end
  # verify the required parameter 'tag_update_query' is set
  if @api_client.config.client_side_validation && tag_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'tag_update_query' when calling TagsApi.update_tag"
  end
  # resource path
  local_var_path = '/api/tags/{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-01-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(tag_update_query)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"TagsApi.update_tag",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end