Update account profile or business facts

PATCH/account

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Request body

requiredapplication/json

namestring

timezonestring

country_codestring

ISO 3166-1 alpha-2 country code

business_factsbusiness_facts

Facts Google requires downstream; collected at onboarding.

Show properties

legal_entity_namestring

support_emailstring<email>

support_phonestring

fulfillment_regionsstring[]

Responses

200

Updated account.

merchant_idstring

namestring

timezonestring

country_codestring

ISO 3166-1 alpha-2 country code

business_factsbusiness_facts

Facts Google requires downstream; collected at onboarding.

Show properties

legal_entity_namestring

support_emailstring<email>

support_phonestring

fulfillment_regionsstring[]

created_atstring<date-time>

locale_optionslocale_options

Reference data for the console's timezone/country selection — countries and their selectable IANA timezones. The client relies entirely on this list rather than validating country/timezone pairs itself.

Show properties

countriescountry_locale[]

Show properties

Array of country_locale

codestring

ISO 3166-1 alpha-2 country code

namestring

time_zonesstring[]

422

Request body failed validation.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

detailsobject | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X PATCH "https://api.sarvex.example.com/v1/account" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "timezone": "string",
  "country_code": "AU",
  "business_facts": {
    "legal_entity_name": "string",
    "support_email": "user@example.com",
    "support_phone": "string",
    "fulfillment_regions": [
      "AU"
    ]
  }
}'

const response = await fetch("https://api.sarvex.example.com/v1/account", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"timezone\": \"string\",\n  \"country_code\": \"AU\",\n  \"business_facts\": {\n    \"legal_entity_name\": \"string\",\n    \"support_email\": \"user@example.com\",\n    \"support_phone\": \"string\",\n    \"fulfillment_regions\": [\n      \"AU\"\n    ]\n  }\n}"
});

import requests

response = requests.patch(
    "https://api.sarvex.example.com/v1/account",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"timezone\": \"string\",\n  \"country_code\": \"AU\",\n  \"business_facts\": {\n    \"legal_entity_name\": \"string\",\n    \"support_email\": \"user@example.com\",\n    \"support_phone\": \"string\",\n    \"fulfillment_regions\": [\n      \"AU\"\n    ]\n  }\n}",
)

Response

{
  "merchant_id": "string",
  "name": "string",
  "timezone": "Australia/Sydney",
  "country_code": "AU",
  "business_facts": {
    "legal_entity_name": "string",
    "support_email": "user@example.com",
    "support_phone": "string",
    "fulfillment_regions": [
      "AU"
    ]
  },
  "created_at": "2019-08-24T14:15:22Z",
  "locale_options": {
    "countries": [
      {
        "code": "AU",
        "name": "Australia",
        "time_zones": [
          "Australia/Sydney"
        ]
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}