PackEdge

Appearance

Portal Settings ​

Read and update your customer-portal configuration: the portal "Account" URL and a count of customers blocked from the portal.

GET   /v1/portal/settings
PATCH /v1/portal/settings

Get settings ​

GET /v1/portal/settings
json
{
  "data": {
    "accountUrl": "https://my-store.com/account",
    "blockedCount": 2
  }
}

Update settings ​

PATCH /v1/portal/settings
FieldRequiredTypeDescription
accountUrlYesstringAbsolute http(s) URL for the portal "Account" link (under 2048 chars), or "" to clear it
json
{
  "data": {
    "ok": true,
    "accountUrl": "https://my-store.com/account"
  }
}

Example ​

bash
curl -X PATCH "https://api.packedge.dev/v1/portal/settings" \
  -H "Authorization: Bearer pk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "accountUrl": "https://my-store.com/account"
  }'