Customers
Initialize
Customers
Initialize
This endpoint is used when you initialize your application's front end
POST
/customers/initialize
x-upmarket-key*
curl --request POST \
--url https://api.upmarket.ai/customers/initialize \
--header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
--data '{
"client_customer_id": "<client_customer_id>",
"journey_id": "<journey_id>",
"customer_type": "<customer_type>",
"customer_name": "<customer_name>"
}'
Header
x-upmarket-keyrequiredDefault: "xxxxxxxxxxxxxxxxxxx"
This is the API Key you generated from Upmarket.
Body
client_customer_idrequired
string
client_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_idrequired
string
journey_id of the Upmarket journey the customer is associated with.
customer_typerequired
string
customer_type the type of customer, either ‘account’ or ‘contact’
customer_namerequired
string
customer_name the name of the customer
Response
customer_id
string
A successful request will return a customer_id
curl --location --request POST 'https://api.upmarket.ai/customers/initialize' \
--header 'Content-Type: application/json' \
--header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
--data-raw '{
"client_customer_id": "",
"journey_id": "",
"customer_type": "",
"customer_name": ""
}'
data: "customer_id"
curl --location --request POST 'https://api.upmarket.ai/customers/initialize' \
--header 'Content-Type: application/json' \
--header 'x-upmarket-key: xxxxxxxxxxxxxxxxxxx' \
--data-raw '{
"client_customer_id": "",
"journey_id": "",
"customer_type": "",
"customer_name": ""
}'
data: "customer_id"