Skip to main content
API docs by Redocly

Clienteling Setup API (0.0.1)

Download OpenAPI specification:Download

Use this resource to set up retailers and stores for clienteling in the NewStore platform. For more information, see how clienteling is used via NewStore Associate App.

Enable clienteling configuration

Represents a new configuration created for retailers to enable clienteling in stores in their business.

Enable clienteling configuration for retailer

Configures clienteling capabilities for an existing retailer. Once configured, the retailer can start clienteling operations in stores in their business.

The ecom_link property contains the link to the e-commerce website of the retailer, which is included along with product recommendations sent to the customer via clienteling messages.

Authorizations:
bearerAuth
header Parameters
Tenant
required
string^[a-z0-9][a-z0-9-]{0,62}$

The name of the tenant making the request.

Request Body schema: application/json
ecom_link
required
string non-empty .*\S.*

The link to the retailer's website. Must not be blank.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "request_id": "ckdk5bwy00009ztlo16062bce",
  • "message": "Something is wrong with the request."
}

Retailer status

Provides read-only onboarding progress for a retailer, including Twilio, templates, stores, and country-level compliance.

Retrieve clienteling onboarding status for retailer

Returns a consolidated view of the retailer's onboarding progress, including Twilio connectivity, SMS disclaimer templates, store coverage, and per-country compliance steps.

Authorizations:
bearerAuth
header Parameters
Tenant
required
string^[a-z0-9][a-z0-9-]{0,62}$

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
{
  • "tenant": "dodici",
  • "onboarded": true,
  • "ecom_link": "https://example.com",
  • "nom_link": "https://manager.d.x.newstore.net/",
  • "onboarded_at": "2019-08-24T14:15:22Z",
  • "twilio": {
    },
  • "whatsapp": {},
  • "opt_in": {
    },
  • "countries": [
    ],
  • "stores": [
    ]
}

Onboarding stores

Contains endpoints that you can use to enable clienteling at specified stores for the retailer.

Note: Ensure that you have the phone number that you intend to use for clienteling conversations in the store.

Onboard store

Onboard a new store to clienteling.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Request Body schema: application/json
One of
kind
string
Enum: "" "dedicated"

Standalone store onboarding. Empty / omitted is treated as dedicated.

phone_number
required
string^\+[0-9]{8,15}$

The phone number that will be used to onboard the store.

bundle_sid
string

Regulatory Bundle ID from Twilio (countries other than US/CA). Must be paired with address_sid.

address_sid
string

Address ID from Twilio. Must be paired with bundle_sid.

sender_group_id
string
Value: ""

Must be omitted or empty for dedicated store onboarding.

phone_number_already_purchased
boolean
Default: false

Skip the Twilio purchase step and only associate the supplied phone_number with the store. Use when the number has already been acquired from Twilio separately (e.g. exclusive numbers such as French mobile numbers).

Responses

Request samples

Content type
application/json
{
  • "kind": "join_existing_group",
  • "sender_group_id": "shared-eu",
  • "phone_number": "+1234567890",
  • "bundle_sid": "BU5e9d0932167fd19bfef4000e0fb15e15",
  • "address_sid": "AD5e9d0932167fd19bfef4000e0fb15e15",
  • "phone_number_already_purchased": false
}

Response samples

Content type
application/json
{
  • "request_id": "ckdk5bwy00009ztlo16062bce",
  • "message": "Something is wrong with the request."
}

Onboard a store to WhatsApp

Onboard a new store to WhatsApp.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Request Body schema: application/json
waba_id
string

WhatsApp Business Account ID to link to the store. Optional when the store joins a sender group that already has a WABA (then inherited).

profile_name
required
string

The name of the WhatsApp profile that will be shown to customers when they interact with the store via WhatsApp.

profile_email
string

Email address that should appear WhatsApp profile

profile_website
string

Website URL that should appear on the WhatsApp profile

profile_picture
string

URL to a logo used as contact image on WhatsApp profile

profile_description
string

A description of the WhatsApp profile

profile_about
string

The 'about' text shown on the WhatsApp profile.

profile_address
string

Business address shown on the WhatsApp profile.

whatsapp_phone_number
string^\+[0-9]{8,15}$

Optional dedicated WhatsApp number in E.164 format. When set, this number is purchased (if not already owned) and registered as the WhatsApp sender instead of the store's SMS number.

bundle_sid
string

Regulatory Bundle ID from Twilio, used only when purchasing a whatsapp_phone_number for countries that require compliance docs.

address_sid
string

Address ID from Twilio, used only when purchasing a whatsapp_phone_number for countries that require compliance docs.

Responses

Request samples

Content type
application/json
{
  • "waba_id": "1234567890",
  • "profile_name": "Dodici Potsdamer Platz by NewStore",
  • "profile_email": "potsdamer-platz@newstore.com",
  • "profile_website": "https://www.newstore.com/",
  • "profile_picture": "https://www.newstore.com/dodici.png",
  • "profile_description": "Giovanna Dodici is a super cool fashion brand.",
  • "profile_about": "Open Mon-Sat, 10:00-20:00.",
  • "profile_address": "Potsdamer Platz 1, 10785 Berlin",
  • "whatsapp_phone_number": "+1234567890",
  • "bundle_sid": "BU5e9d0932167fd19bfef4000e0fb15e15",
  • "address_sid": "AD5e9d0932167fd19bfef4000e0fb15e15"
}

Response samples

Content type
application/json
{
  • "request_id": "ckdk5bwy00009ztlo16062bce",
  • "message": "Something is wrong with the request."
}

Available phone numbers

Represents the phone numbers that are available to be purchased for the store, which can then be used to configure clienteling operations in the store.

See onboarding stores for more information.

List available phone numbers

Retrieves a list of available phone numbers that can be used to enable clienteling operations in a store. The available phone numbers are based on store configuration for the specified store (such as the country code, geography and landline extension).

Once a number has been used to onboard a store, it will be used for clienteling operations in the store.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Addresses

Represents the addresses that are registered with Twilio for the store's country, which can then be used when purchasing phone numbers for countries that require an address.

List addresses

Retrieves a list of addresses registered with Twilio for the store's country. These addresses can be used when purchasing phone numbers for countries that require an address.

The addresses are filtered by the ISO country code of the specified store.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Regulatory Bundles

Represents the regulatory bundles that are registered with Twilio for the store's country, which can then be used when purchasing phone numbers for countries that require regulatory compliance.

List regulatory bundles

Retrieves a list of regulatory bundles registered with Twilio for the store's country. These regulatory bundles can be used when purchasing phone numbers for countries that require regulatory compliance.

The regulatory bundles are filtered by the ISO country code of the specified store.

Authorizations:
bearerAuth
path Parameters
store_id
required
string

The identifier of the store.

header Parameters
Tenant
required
string

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Trust Products

Represents the trust products that are registered with Twilio, which can then be used when purchasing phone numbers for countries that require trust verification.

List trust products

Retrieves a list of trust products registered with Twilio. These trust products can be used when purchasing phone numbers for countries that require trust verification.

Authorizations:
bearerAuth
header Parameters
Tenant
required
string

The name of the tenant making the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Uploads

Generates a WhatsApp profile picture upload URL

Creates an upload URL that can be used to upload a WhatsApp profile picture to S3. The file will be publicly readable.

Authorizations:
bearerAuth
header Parameters
Tenant
required
string

The name of the tenant making the request.

Request Body schema: application/json
file_name
required
string

Profile picture file name. The file name must have a .jpg, .jpeg or .png extension.

Responses

Request samples

Content type
application/json
{
  • "file_name": "profile.png"
}