form resource

Create form resource

post/v1/organizers/{organizerId}/events/{eventId}/forms

Request

Base URL
https://api.plusbilletterie.helloasso.com
URL
https://api.plusbilletterie.helloasso.com/v1/organizers/{organizerId}/events/{eventId}/forms
Auth
API key in header X-API-KEY

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

Request body

namestring

displayNamestring nullable

localeDetailsobject nullable

defaultLocale'fr' | 'en' | 'es' nullable

Example request

{
  "name": "x",
  "displayName": "x",
  "fields": [
    {
      "status": "enabled",
      "visibility": "hidden",
      "name": "x",
      "optional": true,
      "hint": "string",
      "type": "choice",
      "options": [
        "string"
      ],
      "otherInput": true,
      "rule": "min"
    }
  ],
  "defaultLocale": "fr"
}

Response

Success

namestring required

displayNamestring nullable

localeDetailsobject nullable

defaultLocale'fr' | 'en' | 'es' nullable

_idstring objectId required

_createdAtstring date-time required

_updatedAtstring date-time nullable

_referencestring nullable

Example response

{
  "name": "x",
  "displayName": "x",
  "fields": [
    {
      "status": "enabled",
      "visibility": "hidden",
      "name": "x",
      "optional": true,
      "hint": "string",
      "type": "choice",
      "options": [
        "string"
      ],
      "otherInput": true,
      "rule": "min"
    }
  ],
  "defaultLocale": "fr",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.