Creates or updates a Client (Shopper) in BSPK

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": "[email protected]",
    "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",
    "do_not_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",
    "barcode": "1234567890123",
    "profile_type": "person"
  }
}
'

POST

api

platform

clients

Creates or updates a Client (Shopper) in BSPK

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": "[email protected]",
    "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",
    "do_not_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",
    "barcode": "1234567890123",
    "profile_type": "person"
  }
}
'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

client

object

Show child attributes

client.shopper_ref

string

Client's unique identifier provided by your backend system.

Example:

"CLI-789"

client.first_name

string

Client's first name.

Example:

"John"

client.last_name

string

Client's last name.

Example:

"Meyer"

client.alternate_first_name

string

Client's alternate first name.

Example:

"Johnny"

client.alternate_last_name

string

Client's alternate last name.

Example:

"Meyers"

client.gender

string

Gender of the client, being: M = Male or F = Female

Example:

"M"

client.email

string

Client's email

Example:

"[email protected]"

client.mobile_phone

string

Client's mobile phone (with country code)

Example:

"+5511987669944"

client.other_phone

string

Client's other phone (with country code)

Example:

"+551154772457"

client.address

string

Client's address

Example:

"Av. Paulista, 1000"

client.address_2

string

Client's address 2nd line

Example:

"10th floor"

client.address_3

string

Client's address 3rd line

Example:

"Suite 100"

client.address_4

string

Client's address 4th line

Example:

"Building 1"

client.city

string

Client's city

Example:

"New York"

client.state

string

Client's state

Example:

"NY"

client.zip_code

string

Client's zip code

Example:

"10001"

client.country_code

string

Client's country code

Example:

"US"

client.segment

string

Client's segment

Example:

"VIP"

client.preferred_contact_channel

string

Valid entries are chat, email, line, whatsapp, wechat, call

Example:

"whatsapp"

client.nationality

string

Client's Nationality

Example:

"US"

client.passport_number

string

Client's Passport Number

Example:

"AA0199929992"

client.languages

string

Client's languages

Example:

"en;fr"

client.email_contact

string

Define if client gave their aggreement to be contacted by email

Example:

"true"

client.phone_call_contact

string

Define if client gave their aggreement to be contacted by phone call

Example:

"false"

client.chat_contact

string

Define if client gave their aggreement to be contacted by chat

Example:

"false"

client.do_not_contact

string

Define if client should not be contacted, regardless of the other contact preferences

Example:

"false"

client.interested_in_new_products

string

Define if client is interested in receiving messages about new products

Example:

"true"

client.birthday

string

Client's birth day, full or partial (YYYY-MM-DD or MM-DD)

Example:

"1982-02-22"

client.creation_date

string

Client's creation date

Example:

"01/05/2022"

client.store_ref

string

Client's record was created at this store

Example:

"22"

client.sales_associate_ref

string

Client's current associate

Example:

"1101"

client.preferences

string

Client's preferred product categories. Must belong to the company "shopper preferences"

Example:

"Young Professional; Lawyer"

client.ignore_columns

string

Attributes to be ignored during while saving the record (BSPK will not override values for the specified attributes).

Example:

"first_name;last_name"

client.barcode

string

Client's barcode

Example:

"1234567890123"

client.profile_type

enum<string>

Client's profile type (default: person)

Available options:

person,

organization

Example:

"person"

Response

Successful response on update

Introduction Links a BSPK Client with a Client in an external backend system

⌘I

Using the API

Platform API

Extraction API

Creates or updates a Client (Shopper) in BSPK

Authorizations

Body

Response