Module: BrazeAPI::Endpoints::Users::Delete

Included in:
Client
Defined in:
lib/braze_api/endpoints/users/delete.rb

Overview

Methods to call the users/delete endpoint from a client instance

Constant Summary collapse

PATH = 
'/users/delete'

Instance Method Summary collapse

Instance Method Details

#delete_users(external_ids: [], user_aliases: [], braze_ids: []) ⇒ Object

The main method calling the endpoint. Called with an object containing optional keys of external_ids, user_aliases, braze_ids external_ids => optional array of strings braze_ids => optional array of strings user_aliases => optional array of UserAlias objects



16
17
18
19
20
21
22
 
# File 'lib/braze_api/endpoints/users/delete.rb', line 16

def delete_users(external_ids: [], user_aliases: [], braze_ids: [])
  args = {}
  args[:external_ids] = external_ids unless external_ids.empty?
  args[:braze_ids] = braze_ids unless braze_ids.empty?
  args[:user_aliases] = user_aliases unless user_aliases.empty?
  post(PATH, params: args)
end