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

# Redirect to web support

> Create a web support session from metadata passed in the query string and redirect the customer to the public web support site with the session code attached (`sid`). Requires no authentication; the app is identified by its app environment `token`. Extra `customer.*`, `tags`, and `fields.*` query parameters are accepted as session metadata.



## OpenAPI

````yaml https://api.theymes.com/v2/openapi.json get /support/sessions/redirect
openapi: 3.1.0
info:
  title: Theymes API v2
  version: 2.0.0
  description: >-
    Theymes API allows you to interact with the Theymes platform.



    Most endpoints require an API key for authentication. You can generate an
    API key in the Theymes dashboard.



    The API key should be included in the Authorization header
    (```Authorization: Bearer <YOUR_KEY>```).



    The public support link endpoints do not require authentication and are
    grouped separately below.
servers:
  - url: https://api.theymes.com/v2
security: []
tags:
  - name: Authenticated endpoints (API key)
    description: Endpoints that require an API key in the Authorization header.
  - name: Public support links (no authentication)
    description: >-
      Endpoints for creating web support sessions and links. These require no
      authentication and are identified by an app environment token.
paths:
  /support/sessions/redirect:
    get:
      tags:
        - Public support links (no authentication)
      summary: Redirect to web support
      description: >-
        Create a web support session from metadata passed in the query string
        and redirect the customer to the public web support site with the
        session code attached (`sid`). Requires no authentication; the app is
        identified by its app environment `token`. Extra `customer.*`, `tags`,
        and `fields.*` query parameters are accepted as session metadata.
      operationId: redirectToSupport
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: token
          in: query
        - schema:
            type: string
          required: false
          name: language
          in: query
        - schema:
            type: string
            description: >-
              When provided, the user is taken directly to that resource instead
              of the support home page. Must match a resource key configured in
              the Theymes application.
          required: false
          description: >-
            When provided, the user is taken directly to that resource instead
            of the support home page. Must match a resource key configured in
            the Theymes application.
          name: resource
          in: query
        - schema:
            type: string
          required: false
          name: signedMetadataToken
          in: query
        - schema:
            type: string
          required: false
          name: customer.id
          in: query
        - schema:
            type: string
          required: false
          name: customer.name
          in: query
        - schema:
            type: string
            format: email
          required: false
          name: customer.email
          in: query
        - schema:
            type: number
          required: false
          name: customer.tier
          in: query
        - schema:
            type: string
          required: false
          name: tags
          in: query
      responses:
        '307':
          description: >-
            Temporary redirect to the public web support URL with the session
            code attached

````

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