> ## 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.

# Register or rename customer portal

> Requires a verified Firebase or signed personal MCP user and current unblocked membership or billing-administrator access. Team API/OAuth keys cannot impersonate their creator. Effects are shared across live/test modes. Initial registration permits a current member. Rename requires a current administrator, expected_slug matching current state and confirm_existing_links_change true. Renaming changes existing customer links. Slugs are 1-128 ASCII letters/digits and normalized lowercase; uniqueness is fenced across public and legacy web writers. No unregister operation is provided.



## OpenAPI

````yaml openapi.json PUT /teams/{id}/customer-portal
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:
  /teams/{id}/customer-portal:
    put:
      tags:
        - Account Branding
      summary: Register or rename customer portal
      description: >-
        Requires a verified Firebase or signed personal MCP user and current
        unblocked membership or billing-administrator access. Team API/OAuth
        keys cannot impersonate their creator. Effects are shared across
        live/test modes. Initial registration permits a current member. Rename
        requires a current administrator, expected_slug matching current state
        and confirm_existing_links_change true. Renaming changes existing
        customer links. Slugs are 1-128 ASCII letters/digits and normalized
        lowercase; uniqueness is fenced across public and legacy web writers. No
        unregister operation is provided.
      operationId: accountPortalSet
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountPortalInput'
      responses:
        '200':
          description: Current persisted state or explicitly unsaved analysis.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - success
                  - data
                  - timestamp
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/AccountPortal'
                  timestamp:
                    type: number
        '400':
          description: Invalid body, identifier, file or slug.
        '401':
          description: Verified personal credential required.
        '403':
          description: Current administrator required for this action.
        '404':
          description: Team not found or inaccessible.
        '409':
          description: >-
            Slug taken, expected slug changed, rename not confirmed, or team
            pending deletion.
        '500':
          description: >-
            Operation or model analysis could not be confirmed. Read current
            state before retrying a write.
      security:
        - bearerAuth: []
components:
  schemas:
    AccountPortalInput:
      type: object
      additionalProperties: false
      required:
        - slug
      properties:
        slug:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[A-Za-z0-9]+$
        expected_slug:
          type: string
          nullable: true
          maxLength: 128
        confirm_existing_links_change:
          type: boolean
    AccountPortal:
      type: object
      additionalProperties: false
      required:
        - team_id
        - effect_scope
        - slug
        - url
        - can_register
        - can_rename
      properties:
        team_id:
          type: string
        effect_scope:
          type: string
          enum:
            - team_shared
        slug:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
        can_register:
          type: boolean
        can_rename:
          type: boolean
  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.