Settings

Settings endpoints manage API keys, webhooks, profile, payment methods, and system configuration.

API Keys

GET/settings/api-keys🔒 Session

List all API tokens for the current account.

POST/settings/api-keys/generate🔒 Session

Generate a new Sanctum API token.

DELETE/settings/api-keys/{token}/delete🔒 Session

Revoke a specific API token.

---

Webhook Configuration

GET/settings/webhooks🔒 Session

List configured outgoing webhooks.

POST/settings/webhooks/store🔒 Session — can create Webhook

Register a new outgoing webhook.

Field	Type	Required	Description
url	string	Yes	Webhook URL (valid URL)
secret	string	Yes	Webhook secret for signature verification (1–1,000 chars)
eventTypes	array	Yes	Event types to subscribe to (enum values)
eventTypes.*	string	Yes	Event type value
customHeaders	array	No	Custom HTTP headers to include
customHeaders.*.key	string	Yes	Header name (1–100 chars)
customHeaders.*.value	string	Yes	Header value (1–100 chars)

GET/settings/webhooks/{token}/show🔒 Session

View webhook details and delivery history.

DELETE/settings/webhooks/{token}/delete🔒 Session

Delete a webhook configuration.

---

Profile

GET/settings/profile🔒 Session

View current user profile.

PATCH/settings/profile🔒 Session

Update profile information.

PATCH/settings/profile/update-password🔒 Session

Update account password.

PATCH/settings/profile/update-picture🔒 Session

Upload a new profile picture.

DELETE/settings/profile/delete-picture🔒 Session

Delete the current profile picture.

PATCH/settings/profile/toggle-hide-money🔒 Session

Toggle visibility of monetary values in the UI.

---

Payment Settings

GET/settings/payment🔒 Session

View payment method configuration.

PATCH/settings/payment/bank-account🔒 Session

Update bank account details.

PATCH/settings/payment/paypal🔒 Session

Update PayPal payment details.

---

Stock Management Shipping

GET/settings/stock-management/shipping🔒 Session

View stock management shipping settings.

POST/settings/stock-management/shipping/store-or-update🔒 Session

Create or update stock management shipping configuration.

---

Call Center Dispatch Settings

GET/settings/call-center/dispatch🔒 Session

View call center lead dispatch configuration.

POST/settings/call-center/dispatch🔒 Session

Create a dispatch rule.

PATCH/settings/call-center/dispatch/{item}/update🔒 Session

Update a dispatch rule.

PATCH/settings/call-center/dispatch/{item}/reset🔒 Session

Reset a dispatch rule to defaults.

---

Notifications — WhatsApp

GET/settings/notifications/whatsapp🔒 Session

View WhatsApp notification settings.

ANY/settings/notifications/whatsapp/update🔒 Session

Update WhatsApp notification configuration.