Module: BrazeAPI::Endpoints::Users::Identify

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

Overview

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

Constant Summary collapse

PATH = 
'/users/identify'

Instance Method Summary collapse

Instance Method Details

#identify(user_alias:, external_id:) ⇒ Object

The main method calling the endpoint. Called with an object containing the user alias object and the external id of the user being identified.



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/braze_api/endpoints/users/identify.rb', line 12

def identify(user_alias:, external_id:)
  post(
    PATH,
    params: { aliases_to_identify: [
      {
        external_id: external_id,
        user_alias: user_alias
      }
    ] }
  )
end