Braze API Ruby Client

Track users, send messages, export data, and more

⚠️ This library is in early development, subject to breaking changes, and may be discontinued.

Installation

Add the following line to your Gemfile:

gem "braze_api_client"

Followed by running:

bundle install

Or install it yourself as:

gem install braze_api_client

Configuration

Generate an API key with permissions for the endpoints you need to call.

You can determine which API host to use based on your Braze dashboard URL:

Instance	URL	API Host
US-01	https://dashboard-01.braze.com	rest.iad-01.braze.com
US-02	https://dashboard-02.braze.com	rest.iad-02.braze.com
US-03	https://dashboard-03.braze.com	rest.iad-03.braze.com
US-04	https://dashboard-04.braze.com	rest.iad-04.braze.com
US-05	https://dashboard-05.braze.com	rest.iad-05.braze.com
US-06	https://dashboard-06.braze.com	rest.iad-06.braze.com
US-08	https://dashboard-08.braze.com	rest.iad-08.braze.com
EU-01	https://dashboard-01.braze.eu	rest.fra-01.braze.eu
EU-02	https://dashboard-02.braze.eu	rest.fra-02.braze.eu

# Load the gem
require 'braze_api_client'

# Setup authorization
BrazeClient.configure do |config|
  config.access_token = 'YOUR_API_KEY'
  config.server_variables[:host] = 'rest.YOUR-REGION.braze.com'
end

Endpoints

Track users

You can use the /users/track endpoint to record custom events, purchases, and update user profile attributes. Provide up to 75 of each type in a single request.

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.track_users({
    :events => [{
      :external_id => "user123",
      :app_id => "yourappid",
      :time => Time.now,
      :name => "watched_trailer",
    }],
    :attributes => [{
      :external_id => "user456",
      :first_name => "Alice",
      :favorite_color => "blue",
    }],
    :purchases => [
      :external_id => "user456",
      :app_id => "yourappid",
      :time => Time.now,
      :product_id => "product_name",
      :currency => "USD",
      :price => 12.12,
      :quantity => 2,
      :properties => {
        :color => "blue",
      }
    ]
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Delete users

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.delete_users({
    # use any or all of these 3 identifier types
    :external_ids => ["user1", "user2"],
    :user_aliases => ["alias123", "alias456"],
    :braze_ids => ["braze_identifier1", "braze_identifier2"],
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Create new user aliases

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.new_user_aliases({
    :user_aliases => [{
      :external_id => "user123", # optional
      :alias_name => "c123",
      :alias_label => "customer_id",
    }]
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Identify users

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.identify_users({
    :aliases_to_identify => [{
      :external_id => "user123",
      :user_alias => {
        :alias_name => "c123",
        :alias_label => "customer_id",
      }
    }],
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Rename external IDs

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.rename_exernal_ids({
    :external_id_renames => [{
      :current_external_id => "user123",
      :new_external_id => "u123",
    }],
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Remove external IDs

braze_api = BrazeClient::RestApi.new

begin
  result = braze_api.remove_exernal_ids({
    :external_ids => ["user123", "user456"],
  })
  p result
rescue BrazeClient::ApiError => e
  puts "Exception when calling RestApi->users_track: #{e}"
end

Contributing

This library is automatically generated. To make changes, please see braze-api-client-codegen

• API version: 0.1.1
• Package version: 0.1.1
• Build package: org.openapitools.codegen.languages.RubyClientCodegen