Form

Create Form

Endpoint to create a new Form

post/form

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text"
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "description": null,
    "isEnabled": true,
    "shareKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "targetType": "Example Text",
    "fields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "templates": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "targetSettings": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "successMessage": null,
    "ipWhitelist": "This is an example of longer text content that provides detailed information.",
    "logoFile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "logoFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "logoAltText": "Example Text",
    "faviconFile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "faviconFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

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