curl --request PATCH \
--url https://vitarelay.com/api/public/v1/shop \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_enabled": true,
"allow_rnd": true,
"headline": "<string>",
"welcome_message": "<string>"
}
'import requests
url = "https://vitarelay.com/api/public/v1/shop"
payload = {
"is_enabled": True,
"allow_rnd": True,
"headline": "<string>",
"welcome_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_enabled: true,
allow_rnd: true,
headline: '<string>',
welcome_message: '<string>'
})
};
fetch('https://vitarelay.com/api/public/v1/shop', 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://vitarelay.com/api/public/v1/shop",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_enabled' => true,
'allow_rnd' => true,
'headline' => '<string>',
'welcome_message' => '<string>'
]),
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://vitarelay.com/api/public/v1/shop"
payload := strings.NewReader("{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://vitarelay.com/api/public/v1/shop")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitarelay.com/api/public/v1/shop")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"shop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_enabled": true,
"allow_rnd": true,
"headline": "<string>",
"welcome_message": "<string>",
"eligibility": {}
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "payout_setup_incomplete",
"message": "Complete your payout setup before making your store live"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}Update storefront settings
Partial update of storefront settings. Only the supplied fields change. Requires the shop:write scope. Setting is_enabled=true requires the clinic to be payout-eligible. If not, this returns 422 with code payout_setup_incomplete, and Routable payout onboarding is automatically started (the clinic’s admin receives an email + an in-app onboarding link). Poll GET /shop for the payout status; once payout_eligible is true, retry enabling. Building products/bundles and disabling the store are never gated — the gate applies only to is_enabled=true, not to headline, welcome_message, allow_rnd, or is_enabled=false.
curl --request PATCH \
--url https://vitarelay.com/api/public/v1/shop \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_enabled": true,
"allow_rnd": true,
"headline": "<string>",
"welcome_message": "<string>"
}
'import requests
url = "https://vitarelay.com/api/public/v1/shop"
payload = {
"is_enabled": True,
"allow_rnd": True,
"headline": "<string>",
"welcome_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_enabled: true,
allow_rnd: true,
headline: '<string>',
welcome_message: '<string>'
})
};
fetch('https://vitarelay.com/api/public/v1/shop', 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://vitarelay.com/api/public/v1/shop",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_enabled' => true,
'allow_rnd' => true,
'headline' => '<string>',
'welcome_message' => '<string>'
]),
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://vitarelay.com/api/public/v1/shop"
payload := strings.NewReader("{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://vitarelay.com/api/public/v1/shop")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitarelay.com/api/public/v1/shop")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_enabled\": true,\n \"allow_rnd\": true,\n \"headline\": \"<string>\",\n \"welcome_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"shop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_enabled": true,
"allow_rnd": true,
"headline": "<string>",
"welcome_message": "<string>",
"eligibility": {}
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "payout_setup_incomplete",
"message": "Complete your payout setup before making your store live"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid"
}
}Authorizations
API key issued by VitaRelay. Send as Authorization: Bearer vr_live_…
(production) or Authorization: Bearer vr_test_… (sandbox).
Body
Response
The updated settings.
Storefront settings for your clinic's patient shop.
Show child attributes
Show child attributes

