---
title: "Create form resource"
method: POST
path: "/v1/organizers/{organizerId}/events/{eventId}/forms"
tags: ["form resource"]
---

# Create form resource

`POST /v1/organizers/{organizerId}/events/{eventId}/forms`

## Path parameters

- `organizerId` string, objectId, required
- `eventId` string, objectId, required

## Request body

- FormCreate
  - `name` string
  - `displayName` string, nullable
  - `fields` union[], nullable
    - union
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'choice', required
        - `options` string[], required
        - `otherInput` boolean, nullable
        - `rule` 'min' | 'max' | 'equals', nullable
        - `ruleValue` number, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'text', required
        - `rule` union
          - object
            - `type` 'email', required
            - `value` string, email, nullable
          - object
            - `type` 'phone', required
          - object
            - `type` 'url', required
            - `value` string, uri, nullable
          - object
            - `type` 'regex', required
            - `value` string, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'address', required
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'number', required
        - `decimalPlaces` number, nullable
        - `range` object, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'file', required
        - `format` 'image' | 'video' | 'audio' | 'document', nullable
        - `rule` 'min' | 'max' | 'equals', nullable
        - `ruleValue` number, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'date', required
        - `dateUnit` 'minute' | 'hour' | 'day' | 'month' | 'year', required
        - `range` object, required
  - `localeDetails` object, nullable
  - `defaultLocale` 'fr' | 'en' | 'es', nullable

## Response `201`

Success

- Form
  - `name` string, required
  - `displayName` string, nullable
  - `fields` union[], required
    - union
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'choice', required
        - `options` string[], required
        - `otherInput` boolean, nullable
        - `rule` 'min' | 'max' | 'equals', nullable
        - `ruleValue` number, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'text', required
        - `rule` union
          - object
            - `type` 'email', required
            - `value` string, email, nullable
          - object
            - `type` 'phone', required
          - object
            - `type` 'url', required
            - `value` string, uri, nullable
          - object
            - `type` 'regex', required
            - `value` string, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'address', required
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'number', required
        - `decimalPlaces` number, nullable
        - `range` object, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'file', required
        - `format` 'image' | 'video' | 'audio' | 'document', nullable
        - `rule` 'min' | 'max' | 'equals', nullable
        - `ruleValue` number, nullable
      - object
        - `status` 'enabled' | 'disabled', nullable
        - `visibility` 'hidden' | 'visible' | 'emphasized', nullable
        - `externalFormId` unknown
        - `name` string, required
        - `key` unknown, required
        - `optional` boolean, nullable
        - `hint` string, nullable
        - `type` 'date', required
        - `dateUnit` 'minute' | 'hour' | 'day' | 'month' | 'year', required
        - `range` object, required
  - `localeDetails` object, nullable
  - `defaultLocale` 'fr' | 'en' | 'es', nullable
  - `_id` string, objectId, required
  - `_createdAt` string, date-time, required
  - `_updatedAt` string, date-time, nullable
  - `_reference` string, nullable

---

[API](https://skmtc.dev/helloasso/apis/api-authentication-access-token.md) · [All operations](https://skmtc.dev/helloasso/apis/api-authentication-access-token/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/helloasso/api-authentication-access-token/revisions/b8cd7d9ae24e/schema)
