Customers
Initialize
Customers
Initialize
This endpoint is used when you initialize your application’s front end
POST
/
customers
/
initialize
Header
x-upmarket-key
default: "xxxxxxxxxxxxxxxxxxx"required
This is the API Key you generated from Upmarket.
Body
client_customer_id
string
requiredclient_customer_id is the unique identifier for a customer in the source system. Some examples of good client_customer_ids are user uids, an account ids, or customer ids.
journey_id
string
requiredjourney_id of the Upmarket journey the customer is associated with.
customer_type
string
requiredcustomer_type the type of customer, either ‘account’ or ‘contact’
customer_name
string
requiredcustomer_name the name of the customer
Response
customer_id
string
A successful request will return a customer_id