Skip to main content
POST
Request the prepared reset email

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

id
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
operationId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query Parameters

team
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

The body is of type object.

Response

Safe scoped receipt; contains no recipient, reset URL or reviewer proof.

success
enum<boolean>
required
Available options:
true
data
object
required