G
Not authenticated — log in first
VendorProfile

Update My Vendor Profile

Update My Vendor Profile — vendor REST API endpoint.

PATCH/vendor/me/profileVendor bearer token required

Update Vendor Profile

Update your vendor profile fields.

What this means in plain English

Partially update your vendor profile for the selected vendor context. Requires OWNER, ADMIN, or EDITOR role.

When to use this

  • Updating store description or contact information.

Request body

NameTypeRequiredDescription
namestringNoDisplay name.
descriptionstringNoStore description.
supportEmailstringNoSupport email.

Headers

NameTypeRequiredDescription
X-Vendor-Idstring (UUID)YesUUID of the vendor context. Required for vendor-scoped endpoints when your account has multiple vendor memberships. Use the vendor.id from the login response.

Request example

curl -X PATCH 'http://localhost:8080/api/v1/vendor/me/profile' \
  -H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Sands Supply Co.",
  "description": "Updated description",
  "supportEmail": "support@sands.com"
}'

Response examples

200Success
{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "name": "Jane's Store",
  "slug": "janes-store",
  "status": "ACTIVE",
  "description": "Premium supplier catalog",
  "supportEmail": "support@janes-store.com"
}

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid bearer token.

403

Forbidden

Insufficient permissions for this action.

400

Bad Request

Validation failed or invalid parameters.

404

Not Found

Resource not found.

500

Internal Server Error

Unexpected server error.

403

Forbidden

Invalid X-Vendor-Id, no vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).

Try it

Uses your saved session from login. Edit values and send a live request, or copy the cURL command.