Skip to main content
PUT
/
settings
/
profiles
Update Profile Settings
curl --request PUT \
  --url https://staging-api.puppetvendors.com/settings/profiles \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "information": {},
  "socialMedia": {},
  "contactInfo": {},
  "policies": {},
  "vacation": {},
  "others": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Update the authenticated vendor’s profile settings using strict tab-based payload sections. Unknown fields are rejected. Social-media values are normalized to https URLs where applicable. Vendor scope required.

Request Body

information
object
businessLogo, businessLogoId, profileBanner, profileBannerId, description, profileDescription, businessAddress { address1, address2, city, state, postalCode, country }.
socialMedia
object
facebook, instagram, twitter, pinterest, snapchat, youtube, linkedin, whatsapp, tiktok, website.
contactInfo
object
email, phone, location.
policies
object
shippingPolicy, returnsPolicy.
vacation
object
enabled (boolean), timeRange (2-element array of date strings), message.
others
object
hasTax (boolean), vendorTaxRate (number 0–100).

Response

200
{ "success": true, "data": { /* updated profile sections */ } }

Example

curl -X PUT "https://staging-api.puppetvendors.com/settings/profiles" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "information": {
      "description": "Handmade artisan products"
    },
    "socialMedia": {
      "instagram": "myshop",
      "website": "example.com"
    },
    "vacation": {
      "enabled": true,
      "timeRange": ["04/01/2026", "04/10/2026"],
      "message": "Back soon"
    },
    "others": {
      "hasTax": true,
      "vendorTaxRate": 8.25
    }
  }'

More Examples

Update business info and social media
curl -X PUT "https://staging-api.puppetvendors.com/settings/profiles" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -d '{
    "information": {
      "description": "Premium handcrafted goods since 2020",
      "businessAddress": "123 Artisan Way, Portland, OR"
    },
    "socialMedia": {
      "instagram": "https://instagram.com/acmeco",
      "website": "https://acmeco.com"
    }
  }'
Set vacation mode
curl -X PUT "https://staging-api.puppetvendors.com/settings/profiles" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -d '{
    "vacation": {
      "enabled": true,
      "timeRange": ["2026-06-15T00:00:00Z", "2026-07-01T00:00:00Z"],
      "message": "We'\''re on vacation! Orders placed now will ship after July 1st."
    }
  }'