> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Request the prepared reset email

> Save a UUIDv4 before preparing. Current original credential, admin authority, target membership and exact team/mode are independently checked. Preparation sends no email. Execute consumes the confirmed intent before providers; no automatic retry. On an uncertain response read the same UUID. Recovery uses a different UUID and requires a current person in the private browser, never an agent challenge. The earlier code may remain valid and another email may arrive. Provider acceptance is neither delivery nor password change. Reset affects the global login even in test mode.



## OpenAPI

````yaml openapi.json POST /users/{id}/password-reset-operations/{operationId}/execute
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /users/{id}/password-reset-operations/{operationId}/execute:
    post:
      tags:
        - Users
      summary: Request the prepared reset email
      description: >-
        Save a UUIDv4 before preparing. Current original credential, admin
        authority, target membership and exact team/mode are independently
        checked. Preparation sends no email. Execute consumes the confirmed
        intent before providers; no automatic retry. On an uncertain response
        read the same UUID. Recovery uses a different UUID and requires a
        current person in the private browser, never an agent challenge. The
        earlier code may remain valid and another email may arrive. Provider
        acceptance is neither delivery nor password change. Reset affects the
        global login even in test mode.
      operationId: executePasswordResetOperation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,128}$
        - name: operationId
          in: path
          required: true
          schema:
            type: string
            pattern: >-
              ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        - name: team
          in: query
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,128}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties: {}
      responses:
        '200':
          description: >-
            Safe scoped receipt; contains no recipient, reset URL or reviewer
            proof.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    additionalProperties: false
                    required:
                      - operation_id
                      - team_id
                      - user_id
                      - livemode
                      - password_change
                      - status
                      - attempt_in_progress
                      - claim_expires_at
                      - email_delivery
                      - started_at
                      - updated_at
                    properties:
                      operation_id:
                        type: string
                        pattern: >-
                          ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
                      team_id:
                        type: string
                        pattern: ^[A-Za-z0-9_-]{1,128}$
                      user_id:
                        type: string
                        pattern: ^[A-Za-z0-9_-]{1,128}$
                      livemode:
                        type: boolean
                      password_change:
                        type: string
                        enum:
                          - not_verified
                      status:
                        type: string
                        enum:
                          - prepared
                          - outcome_unknown
                          - generation_unknown
                          - generated_unsent
                          - email_unknown
                          - provider_accepted
                          - canceled
                      attempt_in_progress:
                        type: boolean
                      claim_expires_at:
                        type: integer
                        minimum: 0
                        nullable: true
                      email_delivery:
                        type: string
                        enum:
                          - not_attempted
                          - unknown
                          - provider_accepted
                      started_at:
                        type: integer
                        minimum: 0
                      updated_at:
                        type: integer
                        minimum: 0
        default:
          description: Refusal or unconfirmed outcome. Retain the UUID and read status.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    additionalProperties: false
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **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](https://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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.