Creates a new form - cobra CRM Cloud

Request

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Accept-Language

string

optional

Example:

Body Params application/json

Input DTO for a form

name

string

required

Name of the form

>= 1 characters<= 200 characters

Example:

Demo Form

description

string | null

optional

Description of the form

<= 10000 characters

Example:

A simple demo form

title

string | null

optional

Title displayed at the top of the form

<= 200 characters

Example:

Welcome to our Demo Form

footerText

string | null

optional

Text displayed at the bottom of the form

<= 10000 characters

Example:

Thank you for your interest

appearanceSettings

object (AppearanceConfigInputDto)

required

Visual appearance settings of the form

backgroundImageUrl

string | null

optional

Optional background image for the form that overrides the background color of the color config

Example:

null

colorSettings

object (ColorConfigInputDto)

required

Color settings for form appearance

titleFont

string

required

Font family for titles

>= 1 characters

Example:

Arial

textFont

string

required

Font family for body text

>= 1 characters

Example:

Helvetica

showShadow

boolean

required

Indicates if elements should have shadow effects

Example:

true

displayHeaderImage

boolean | null

optional

Controls visibility of the header image

Example:

false

logoImageMode

enum<string>

required

Allowed values:

LightColorDarkColorHide

customCss

string | null

optional

Custom CSS styles for the form

Example:

null

legalNotice

object (LegalNoticesConfigInputDto)

optional

Legal notice configuration for the form

legalDisclosureLink

string | null

optional

Link to the legal disclosure page

Example:

https://example.com/legal

privacyPolicyLink

string | null

optional

Link to the privacy policy page

Example:

https://example.com/privacy

formFields

array[null (FormElementBase) {18}] | null

optional

Collection of form fields that make up the form

object

LabelField

optional

Static text field with HTML formatting support

object

TitleField

optional

Title field with HTML formatting support

object

Spacer

optional

Visual spacing element for form layout

object

TextInputField

optional

Single-line text input field

object

TextAreaInputField

optional

Multi-line text input field

object

EmailInputField

optional

Input field for entering an email address

object

PhoneInputField

optional

Input field for entering a phone number

object

UrlInputField

optional

Input field for entering a website URL

object

IntegerInputField

optional

Input field for an integer value

object

DecimalInputField

optional

Input field for a decimal value

object

DateTimeInputField

optional

Input field for date and time selection

object

SingleSelectionField

optional

Input field for selecting a single option from a list

object

MultipleSelectionField

optional

Input field for selecting multiple options from a list

object

RatingField

optional

Input field for ratings and scales

object

ConsentField

optional

Input field for capturing consent confirmations

object

NameInputField

optional

Input field for capturing a first and last name

object

SalutationGroupInputField

optional

Group of fields for capturing title and salutation

object

AddressGroupInputField

optional

Group of fields for capturing an address

useCaptcha

boolean

optional

Indicates if CAPTCHA verification is added to the form

Example:

false

emailNotificationConfig

object (EmailNotificationConfigInputDto)

optional

Email notification configuration for form submissions

emails

array[string] | null

optional

List of email addresses to receive notifications

Example:

["notifications@example.com","admin@example.com"]

isEmailNotificationActive

boolean

optional

Indicates if email notifications are enabled

Example:

false

Example

{
    "name": "Demo Form",
    "description": "A simple demo form",
    "title": "Welcome to our Demo Form",
    "footerText": "Thank you for your interest",
    "appearanceSettings": {
        "backgroundImageUrl": null,
        "colorSettings": {
            "backgroundColor": "#F8F9FA",
            "textColor": "#212529",
            "linkColor": "#0D6EFD",
            "buttonTextColor": "#FFFFFF",
            "buttonBackgroundColor": "#0D6EFD",
            "buttonHoverTextColor": "#FFFFFF",
            "buttonHoverBackgroundColor": "#0B5ED7"
        },
        "titleFont": "Arial",
        "textFont": "Helvetica",
        "showShadow": true,
        "displayHeaderImage": false,
        "logoImageMode": "LightColor",
        "customCss": null
    },
    "legalNotice": {
        "legalDisclosureLink": "https://example.com/legal",
        "privacyPolicyLink": "https://example.com/privacy"
    },
    "formFields": [
        {
            "order": null,
            "label": "Field label",
            "kind": "Label"
        }
    ],
    "useCaptcha": false,
    "emailNotificationConfig": {
        "emails": [
            "notifications@example.com",
            "admin@example.com"
        ],
        "isEmailNotificationActive": false
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Created

Body

data

object (CobraFormOutputDto)

optional

Complete form information

string | null

optional

Gets or sets the identifier for the entity.

Example:

123456789012345678901234

createdBy

string | null

optional

Gets or sets the name of the user who created the entity, if available.

Example:

Username

modifiedBy

string | null

optional

Gets or sets the name of the user who last modified the entity, if available.

Example:

Username

dateCreated

string <date-time> | null

optional

Gets or sets the date and time when the entity was created, if available.

Example:

2024-02-19T08:57:43.041Z

dateModified

string <date-time> | null

optional

Gets or sets the date and time when the entity was last modified, if available.

Example:

2024-02-19T08:57:43.041Z

createdByUserId

string <uuid> | null

optional

Gets or sets the ID of the user who created the entity, if available.

Example:

c0316f28-4d2d-4c79-b5fc-bd25f2bca40c

modifiedByUserId

string <uuid> | null

optional

Gets or sets the ID of the user who last modified the entity, if available.

Example:

c0316f28-4d2d-4c79-b5fc-bd25f2bca40c

name

string | null

optional

Name of the form

Example:

Demo Form

description

string | null

optional

Description of the form

Example:

A simple demo form

title

string | null

optional

Title displayed at the top of the form

Example:

Welcome to our Demo Form

footerText

string | null

optional

Text displayed at the bottom of the form

Example:

Thank you for your interest

appearanceSettings

object (AppearanceConfigOutputDto)

optional

Visual appearance settings of the form

legalNotice

object (LegalNoticesConfigOutputDto)

optional

Legal notice configuration for the form

formFields

array[null (FormElementBaseOutput) {18}] | null

optional

Collection of form fields that make up the form

useCaptcha

boolean

optional

Indicates if CAPTCHA verification is added to the form

Example:

false

isCopy

boolean

read-onlyoptional

Indicates if this form is a copy of another form

Example:

false

isPublished

boolean

optional

Indicates if the form is publicly available

Example:

true

publishedDate

string <date-time> | null

optional

When the form was made publicly available

Example:

2025-05-13T10:30:00Z

fullLink

string | null

optional

Complete URL to access the form

Example:

https://tenantabc.crm-formulare.de/ab12

qrCodeLink

string | null

optional

URL to QR code image of the form link

Example:

null

emailNotificationConfig

object (EmailNotificationConfigOutputDto)

optional

Email notification configuration for form submissions

responseCount

integer <int32>

optional

Total number of form submissions

Example:

lastResponseDate

string <date-time> | null

optional

When the most recent form submission occurred

Example:

2025-05-13T10:30:00Z

message

string | null

optional

metaData

object (ResponseMetaData)

optional

totalResults

integer <int32>

optional

responseTimeStamp

string <date-time>

optional

statusCode

integer <int32>

optional

Example

{
    "data": {
        "id": "123456789012345678901234",
        "createdBy": "Username",
        "modifiedBy": "Username",
        "dateCreated": "2024-02-19T08:57:43.041Z",
        "dateModified": "2024-02-19T08:57:43.041Z",
        "createdByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "modifiedByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "name": "Demo Form",
        "description": "A simple demo form",
        "title": "Welcome to our Demo Form",
        "footerText": "Thank you for your interest",
        "appearanceSettings": {
            "headerImage": {
                "imageUrl": "https://dev-public.crm-dateien.de/22e39e53-aae1-4d8d-8478-e782deccbef0/EventPro.PortalConfig/PortalImages/334553c9-aec6-4227-89da-fb8d1ea0258e.png",
                "imageAltText": "test image",
                "width": 40,
                "height": 40
            },
            "lightColorLogoImage": {
                "imageUrl": "https://dev-public.crm-dateien.de/22e39e53-aae1-4d8d-8478-e782deccbef0/EventPro.PortalConfig/PortalImages/334553c9-aec6-4227-89da-fb8d1ea0258e.png",
                "imageAltText": "test image",
                "width": 40,
                "height": 40
            },
            "darkColorLogoImage": {
                "imageUrl": "https://dev-public.crm-dateien.de/22e39e53-aae1-4d8d-8478-e782deccbef0/EventPro.PortalConfig/PortalImages/334553c9-aec6-4227-89da-fb8d1ea0258e.png",
                "imageAltText": "test image",
                "width": 40,
                "height": 40
            },
            "backgroundImageUrl": null,
            "colorSettings": {
                "backgroundColor": "#F8F9FA",
                "textColor": "#212529",
                "linkColor": "#0D6EFD",
                "buttonTextColor": "#FFFFFF",
                "buttonBackgroundColor": "#0D6EFD",
                "buttonHoverTextColor": "#FFFFFF",
                "buttonHoverBackgroundColor": "#0B5ED7"
            },
            "titleFont": "Arial",
            "textFont": "Helvetica",
            "showShadow": true,
            "displayHeaderImage": true,
            "logoImageMode": "LightColor",
            "customCss": null
        },
        "legalNotice": {
            "legalDisclosureLink": "https://example.com/legal",
            "privacyPolicyLink": "https://example.com/privacy"
        },
        "formFields": [
            {
                "order": null,
                "label": "Field label",
                "kind": "Label"
            }
        ],
        "useCaptcha": false,
        "isCopy": false,
        "isPublished": true,
        "publishedDate": "2025-05-13T10:30:00Z",
        "fullLink": "https://tenantabc.crm-formulare.de/ab12",
        "qrCodeLink": null,
        "emailNotificationConfig": {
            "emails": [
                "notifications@example.com",
                "admin@example.com"
            ],
            "isEmailNotificationActive": false
        },
        "responseCount": 42,
        "lastResponseDate": "2025-05-13T10:30:00Z"
    },
    "message": "string",
    "metaData": {
        "totalResults": 0,
        "responseTimeStamp": "2019-08-24T14:15:22Z"
    },
    "statusCode": 0
}

🟠400Bad Request