Skip to main content
PATCH
Update your team preferences

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Path Parameters

teamId
string
required

A team where you currently have active membership.

Pattern: ^[A-Za-z0-9_-]{1,256}$

Body

application/json

Supply at least one preference. Null resets that preference, preserving other settings and teams.

testmode
boolean | null
search_collection
enum<string> | null
Available options:
payments,
invoices,
receipts,
null
invoices_order_by
enum<string> | null
Available options:
timestamp,
folio_number,
null

Response

Persisted account state or action result.

success
boolean
required
data
object
required
timestamp
number
required