POST customer create or update

post

https://api.hikeup.com/api/v1/customers/createOrUpdate

Create or update a customer by id

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Enter customer request model

Customer details

first_name

string

required

Customer first name

last_name

string

Customer last name

company_name

string

Customer's business name

phone

string

Customer's primary phone number

customer_code

string

Customer code in Hike

string

required

Customer's email address

billing_address_id

int32

Customer's delivery address record id, 0 to create a new address which will be automatically assigned and included in the response

delivery_address_id

int32

Customer's billing Address record id, 0 to create a new address which will be automatically assigned and included in the response

customer_group_id

int32

Customer group id

notes

string

Internal notes

loyalty_rewards_status

boolean

Has this customer signed up for loyalty rewards?

birth_date

date-time

Customer's birth date

gender

int32

Customer's gender

loyalty_balance

double

Customer's current loyalty balance

reward_points_used

double

Reward points used so far

credit_limit

double

Credit limit approved for this customer's account

credit_balance

double

Customer's credit balance - balance of amount business owes to the customer

account_balance

double

Balance of amount customer is owing

lead_source

int32

Marketing question 'how did you hear about us?'

billing_address

object

Customer's address details

shipping_address

object

Customer's address details

delivery_address

array of objects

Customer's delivery address

delivery_address

created_date

date-time

Customer profile created on

last_modified

date-time

Customer's profile last modified date

customer_group

object

Customer's group details

accepts_marketing

boolean

Customer has opted in to receive marketing and promo communications

custom_field_1

string

Customer extra custom field 1

custom_field_2

string

Customer extra custom field 2

custom_field_3

string

Customer extra custom field 3

custom_field_4

string

Customer extra custom field 4

customer_tags

array of objects

Customer filter tags e.g: best, retail, new

customer_tags

isActive

boolean

Is active or not?

int32

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200

Language

Loading…

Response

Click Try It! to start a request and see the response here!