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

# Update form

> Requires `write:forms`.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/marketing/forms/{id}
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/marketing/forms/{id}:
    patch:
      tags:
        - Marketing
      summary: Update form
      description: Requires `write:forms`.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1FormUpdate'
      responses:
        '200':
          description: Updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1FormResponse'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1FormUpdate:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        slug:
          type: string
          minLength: 1
        description:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - draft
            - published
            - closed
        visibility:
          type: string
          enum:
            - public
            - invite_only
            - customers_only
        fields:
          type: array
          items:
            type: object
            additionalProperties:
              nullable: true
        settings:
          type: object
          additionalProperties:
            nullable: true
        themePrimaryColor:
          type: string
          nullable: true
        themeBackgroundColor:
          type: string
          nullable: true
        successMessage:
          type: string
          nullable: true
        closeAt:
          type: string
          nullable: true
          format: date-time
        maxResponses:
          type: integer
          nullable: true
        requireEmail:
          type: boolean
        requireName:
          type: boolean
        requirePhone:
          type: boolean
        allowMultipleSubmissions:
          type: boolean
        regenerateInviteCode:
          type: boolean
    V1FormResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/V1Form'
      required:
        - data
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
    V1Form:
      type: object
      properties:
        id:
          type: string
          format: uuid
        teamId:
          type: string
        name:
          type: string
        slug:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
        visibility:
          type: string
        inviteCode:
          type: string
          nullable: true
        fields:
          type: array
          items:
            type: object
            additionalProperties:
              nullable: true
        settings:
          type: object
          additionalProperties:
            nullable: true
        themePrimaryColor:
          type: string
          nullable: true
        themeBackgroundColor:
          type: string
          nullable: true
        successMessage:
          type: string
          nullable: true
        closeAt:
          type: string
          nullable: true
          format: date-time
        maxResponses:
          type: integer
          nullable: true
        responseCount:
          type: integer
        requireEmail:
          type: boolean
        requireName:
          type: boolean
        requirePhone:
          type: boolean
        allowMultipleSubmissions:
          type: boolean
        publishedAt:
          type: string
          nullable: true
          format: date-time
        createdAt:
          type: string
          nullable: true
          format: date-time
        updatedAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - teamId
        - name
        - slug
        - description
        - status
        - visibility
        - inviteCode
        - fields
        - settings
        - themePrimaryColor
        - themeBackgroundColor
        - successMessage
        - closeAt
        - maxResponses
        - responseCount
        - requireEmail
        - requireName
        - requirePhone
        - allowMultipleSubmissions
        - publishedAt
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Update, assign, or reschedule an event](/docs/schedule/update-assign-or-reschedule-an-event.md)
- [Add hours, map, contacts, and social links to your website](/docs/facility-web-pages/add-hours-map-contacts-and-social-to-your-website.md)
- [List forms](/docs/api-reference/marketing/list-forms.md)
- [Create form](/docs/api-reference/marketing/create-form.md)
- [Delete form](/docs/api-reference/marketing/delete-form.md)


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