Using the API
Platform API
Extraction API
- Introduction
- Appointments
- Calls
- Clients
- Emails
- Ideabook
- Messages
- Notes
- Reminders
- Sales Associates
- Slices
Clients
Creates or updates a Client (Shopper) in BSPK
Creates or updates a Shopper in BSPK
POST
/
api
/
platform
/
v1
/
clients
Copy
curl --request POST \
--url https://api.bspk.com/api/platform/v1/clients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"client": {
"shopper_ref": "CLI-789",
"first_name": "John",
"last_name": "Meyer",
"alternate_first_name": "Johnny",
"alternate_last_name": "Meyers",
"gender": "M",
"email": "client1@email.com",
"mobile_phone": "+5511987669944",
"other_phone": "+551154772457",
"address": "Av. Paulista, 1000",
"address_2": "10th floor",
"address_3": "Suite 100",
"address_4": "Building 1",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"country_code": "US",
"segment": "VIP",
"preferred_contact_channel": "whatsapp",
"nationality": "US",
"passport_number": "AA0199929992",
"languages": "en;fr",
"email_contact": "true",
"phone_call_contact": "false",
"chat_contact": "false",
"interested_in_new_products": "true",
"birthday": "1982-02-22",
"creation_date": "01/05/2022",
"store_ref": "22",
"sales_associate_ref": "1101",
"preferences": "Young Professional; Lawyer",
"ignore_columns": "first_name;last_name"
}
}'
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
Successful response on update
Copy
curl --request POST \
--url https://api.bspk.com/api/platform/v1/clients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"client": {
"shopper_ref": "CLI-789",
"first_name": "John",
"last_name": "Meyer",
"alternate_first_name": "Johnny",
"alternate_last_name": "Meyers",
"gender": "M",
"email": "client1@email.com",
"mobile_phone": "+5511987669944",
"other_phone": "+551154772457",
"address": "Av. Paulista, 1000",
"address_2": "10th floor",
"address_3": "Suite 100",
"address_4": "Building 1",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"country_code": "US",
"segment": "VIP",
"preferred_contact_channel": "whatsapp",
"nationality": "US",
"passport_number": "AA0199929992",
"languages": "en;fr",
"email_contact": "true",
"phone_call_contact": "false",
"chat_contact": "false",
"interested_in_new_products": "true",
"birthday": "1982-02-22",
"creation_date": "01/05/2022",
"store_ref": "22",
"sales_associate_ref": "1101",
"preferences": "Young Professional; Lawyer",
"ignore_columns": "first_name;last_name"
}
}'
Assistant
Responses are generated using AI and may contain mistakes.