Bulk upsert metafields for a shopper
curl --request PUT \
--url https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metafields": [
{
"namespace": "custom",
"key": "loyalty_tier",
"value": "gold",
"value_type": "single_line_text_field",
"is_list": false
}
]
}
'import requests
url = "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields"
payload = { "metafields": [
{
"namespace": "custom",
"key": "loyalty_tier",
"value": "gold",
"value_type": "single_line_text_field",
"is_list": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metafields: [
{
namespace: 'custom',
key: 'loyalty_tier',
value: 'gold',
value_type: 'single_line_text_field',
is_list: false
}
]
})
};
fetch('https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'metafields' => [
[
'namespace' => 'custom',
'key' => 'loyalty_tier',
'value' => 'gold',
'value_type' => 'single_line_text_field',
'is_list' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields"
payload := strings.NewReader("{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": 123,
"namespace": "<string>",
"key": "<string>",
"value": "<string>",
"value_type": "<string>",
"is_list": true,
"created_at": "<string>",
"updated_at": "<string>",
"json_value": null
}
]Shopper Metafields
Bulk upsert metafields for a shopper
Creates or updates metafields for the specified shopper. Metafields are matched by namespace and key.
PUT
/
api
/
platform
/
v1
/
shoppers
/
{shopper_ref}
/
metafields
Bulk upsert metafields for a shopper
curl --request PUT \
--url https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metafields": [
{
"namespace": "custom",
"key": "loyalty_tier",
"value": "gold",
"value_type": "single_line_text_field",
"is_list": false
}
]
}
'import requests
url = "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields"
payload = { "metafields": [
{
"namespace": "custom",
"key": "loyalty_tier",
"value": "gold",
"value_type": "single_line_text_field",
"is_list": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metafields: [
{
namespace: 'custom',
key: 'loyalty_tier',
value: 'gold',
value_type: 'single_line_text_field',
is_list: false
}
]
})
};
fetch('https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'metafields' => [
[
'namespace' => 'custom',
'key' => 'loyalty_tier',
'value' => 'gold',
'value_type' => 'single_line_text_field',
'is_list' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields"
payload := strings.NewReader("{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bspk.com/api/platform/v1/shoppers/{shopper_ref}/metafields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metafields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"loyalty_tier\",\n \"value\": \"gold\",\n \"value_type\": \"single_line_text_field\",\n \"is_list\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": 123,
"namespace": "<string>",
"key": "<string>",
"value": "<string>",
"value_type": "<string>",
"is_list": true,
"created_at": "<string>",
"updated_at": "<string>",
"json_value": null
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Shopper external ID
Body
application/json
Show child attributes
Show child attributes
⌘I
