Skip to main content
POST
https://api.upmarket.ai
/
customers
/
initialize
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"
​
x-upmarket-key
default:"xxxxxxxxxxxxxxxxxxx"
required
This is the API Key you generated from Upmarket.

​
Body

​
client_customer_id
string
required
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_id
string
required
journey_id of the Upmarket journey the customer is associated with.
​
customer_type
string
required
customer_type the type of customer, either ‘account’ or ‘contact’
​
customer_name
string
required
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"