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

# Preview



## OpenAPI

````yaml /openapi.json post /v1/workspaces/{workspaceId}/locations/{locationId}/preview
openapi: 3.1.0
info:
  title: Specurate API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://app.specurate.com/api
    description: API Server
security: []
tags: []
paths:
  /v1/workspaces/{workspaceId}/locations/{locationId}/preview:
    post:
      tags:
        - Locations
      summary: Preview
      operationId: LocationsController_preview_v1
      parameters:
        - name: workspaceId
          required: true
          in: path
          schema:
            type: string
        - name: locationId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationUpdatePreviewResponseDto'
components:
  schemas:
    UpdateLocationDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        address:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 2000
            - type: 'null'
        apartment:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 255
            - type: 'null'
        city:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 255
            - type: 'null'
        state:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 255
            - type: 'null'
        zipCode:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 32
            - type: 'null'
        country:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 100
            - type: 'null'
        countryCode:
          anyOf:
            - type: string
              pattern: ^[A-Z]{2}$
            - type: 'null'
        subdivisionCode:
          anyOf:
            - type: string
              pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
            - type: 'null'
        placeId:
          anyOf:
            - type: string
              pattern: ^[A-Za-z0-9_-]{1,300}$
            - type: 'null'
        region:
          anyOf:
            - type: string
              pattern: ^[a-z][a-z0-9_]{0,63}$
            - type: 'null'
        expectedPreview:
          type: string
          pattern: ^[a-f0-9]{64}$
      additionalProperties: false
    LocationUpdatePreviewResponseDto:
      type: object
      properties:
        fingerprint:
          type: string
        region:
          type:
            - string
            - 'null'
        projects:
          type: array
          items:
            $ref: '#/components/schemas/LocationMoveProjectResponseDto'
        gaining:
          type: array
          items:
            $ref: '#/components/schemas/LocationMoveTeamResponseDto'
        losing:
          type: array
          items:
            $ref: '#/components/schemas/LocationMoveTeamResponseDto'
      required:
        - fingerprint
        - region
        - projects
        - gaining
        - losing
    LocationMoveProjectResponseDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        region:
          type:
            - string
            - 'null'
      required:
        - id
        - name
        - region
    LocationMoveTeamResponseDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        reason:
          type: string
          enum:
            - all
            - location
            - region
            - explicit
        memberCount:
          type: number
        projectCount:
          type: number
      required:
        - id
        - name
        - reason
        - memberCount
        - projectCount

````

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