SegmentsApi.md

VoucherifySdk::SegmentsApi

All URIs are relative to https://api.voucherify.io

Method	HTTP request	Description
delete_segment	DELETE /v1/segments/{segmentId}	Delete Segment

delete_segment

delete_segment(segment_id)

Delete Segment

This method deletes a customer segment.

Examples

require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
  # Configure API key authorization: X-App-Id
  config.api_key['X-App-Id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-App-Id'] = 'Bearer'

  # Configure API key authorization: X-App-Token
  config.api_key['X-App-Token'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-App-Token'] = 'Bearer'
end

api_instance = VoucherifySdk::SegmentsApi.new
segment_id = 'segment_id_example' # String | A unique customer segment ID.

begin
  # Delete Segment
  api_instance.delete_segment(segment_id)
rescue VoucherifySdk::ApiError => e
  puts "Error when calling SegmentsApi->delete_segment: #{e}"
end

Parameters

Name	Type	Description	Notes
segment_id	String	A unique customer segment ID.

Return type

nil (empty response body)

Authorization

X-App-Id, X-App-Token

HTTP request headers

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