Deftform

https://help.deftform.com/
Admin
Deftform is an online form builder that enables users to create various types of forms with...
Tokens:17,618
Snippets:169
Trust Score:8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Basic Event Tracking Script (JavaScript)

Source: https://help.deftform.com/nice-to-know/add-google-tag-manager-to-your-forms

An example of a JavaScript snippet to push a custom event to the dataLayer for tracking basic events. This can be used to track user interactions or specific actions within your form.

```javascript
dataLayer.push({
  'event': 'custom_event',
  'event_category': 'engagement',
  'event_action': 'visit',
  'event_label': 'demo_form'
});
```

--------------------------------

### Accessing Deftform Data in Make using get() function

Source: https://help.deftform.com/integrations/make

This example demonstrates how to use the 'get()' function within Make to retrieve a specific response value from the 'data' array based on its UUID. This is useful for mapping Deftform fields to columns in a Google Sheet.

```make
{{get(map(1.data; "response"; "uuid"; "daf7bc5f-4693-4a72-b023-0ef6255d23fa"); 1)}}
```

--------------------------------

### GET /forms

Source: https://help.deftform.com/api/endpoints

Fetches all forms and their associated fields. Requires an authorization token.

```APIDOC
## GET /forms

### Description
Fetches all forms and their associated fields. Requires an authorization token.

### Method
GET

### Endpoint
/forms

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/forms \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **forms** (array) - An array of form objects, each containing form details and fields.

#### Response Example
```json
{
  "forms": [
    {
      "id": "form_abc",
      "name": "Contact Form",
      "fields": [
        {
          "id": "field_uuid_1",
          "label": "Email"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /workspace

Source: https://help.deftform.com/api/endpoints

Retrieves access to a workspace. Requires an authorization token.

```APIDOC
## GET /workspace

### Description
Retrieves access to a workspace. Requires an authorization token.

### Method
GET

### Endpoint
/workspace

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/workspace \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **workspace_data** (object) - Contains workspace details.

#### Response Example
```json
{
  "workspace_data": {
    "id": "ws_123",
    "name": "My Workspace"
  }
}
```
```

--------------------------------

### GET /responses/{formId}

Source: https://help.deftform.com/api/endpoints

Fetches all responses for a specific form. Requires an authorization token.

```APIDOC
## GET /responses/{formId}

### Description
Fetches all responses for a specific form. Requires an authorization token.

### Method
GET

### Endpoint
/responses/{formId}

### Parameters
#### Path Parameters
- **formId** (string) - Required - The ID of the form (e.g., `OUm6T9`).

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/responses/YOUR_FORM_ID \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **responses** (array) - An array of response objects for the specified form.

#### Response Example
```json
{
  "responses": [
    {
      "id": "response_uuid_1",
      "submitted_at": "2023-10-27T10:00:00Z",
      "data": {
        "field_uuid_1": "John Doe"
      }
    }
  ]
}
```
```

--------------------------------

### Example Form Submission Tracking Script (JavaScript)

Source: https://help.deftform.com/nice-to-know/add-google-tag-manager-to-your-forms

A JavaScript snippet for tracking form submissions. This pushes event data to the dataLayer, including details about the form and its submission, which is useful for conversion tracking.

```javascript
dataLayer.push({
  'event': 'form_submit',
  'event_category': 'form',
  'event_action': 'submit',
  'event_label': 'contact_form',
  'form_id': 'contact-us',
  'form_name': 'Contact Form'
});
```

--------------------------------

### GET /response/{UUID}/pdf

Source: https://help.deftform.com/api/endpoints

Generates a PDF summary of a specific submission. Requires an authorization token.

```APIDOC
## GET /response/{UUID}/pdf

### Description
Generates a PDF summary of a specific submission. Requires an authorization token. The UUID can be obtained from the "Form responses" endpoint.

### Method
GET

### Endpoint
/response/{UUID}/pdf

### Parameters
#### Path Parameters
- **UUID** (string) - Required - The unique identifier of the submission.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/response/YOUR_SUBMISSION_UUID/pdf \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **pdf_link** (string) - A URL to the generated PDF file.

#### Response Example
```json
{
  "pdf_link": "https://deftform.com/path/to/your/submission.pdf"
}
```
```

--------------------------------

### Dynamic Parameters for Paragraph Element

Source: https://help.deftform.com/nice-to-know/pre-fill-fields-via-url-parameter

This example shows how to set dynamic parameters for the 'Paragraph' element in Deftform. Parameters are passed using the 'setter=' format, followed by key-value pairs enclosed in square brackets (e.g., '[key=value]'). Multiple setters can be added sequentially. Placeholders in the paragraph text (e.g., '###NAME###') are replaced with the corresponding values.

```URL
https://forms.ivymayhem.io/hLSxBO?setter=[name=Madison][order_id=12345]&lkjhw=madison@example.com
```

```Text
Hello ###NAME###! 👋 Let us know your feedback about your recent order ###ORDER_ID### and win a $50 discount for your next purchase in our shop.
```

--------------------------------

### Pre-fill Form Fields with URL Parameters

Source: https://help.deftform.com/nice-to-know/pre-fill-fields-via-url-parameter

This example demonstrates how to pre-fill 'Short answer (Input)' and 'Hidden' fields in a Deftform using URL parameters. Custom field identifiers are appended to the form URL after a '?' for the first parameter and '&' for subsequent parameters. The length of pre-filled values is limited to 255 characters.

```URL
https://forms.ivymayhem.io/yJgdHh?zfytq=Ivy&lkjhw=Hamburg
```

--------------------------------

### Deftform API Response Example

Source: https://help.deftform.com/integrations/make

This JSON object represents a typical response from the Deftform API, containing submission details and an array of form data. It's used to illustrate how to access specific fields within the response.

```json
{
  "id": "56c4e599-0cec-4bb3-aac5-6e64076ae805",
  "number": 9,
  "number_formatted": "Prefix-9-Suffix",
  "form_id": "4acb658c-3712-47c6-9b36-06e096c188ae",
  "form_name": "Make Test",
  "referrer": null,
  "data": [
    {
      "label": "First Name",
      "response": "Mike",
      "uuid": "ae9f05c9-d306-4166-920f-c63e624f62b4",
      "custom_key": null
    },
    {
      "label": "Email Address",
      "response": "mike@example.com",
      "uuid": "daf7bc5f-4693-4a72-b023-0ef6255d23fa",
      "custom_key": null
    }
  ]
}
```

--------------------------------

### Access Workspace via cURL

Source: https://help.deftform.com/api/introduction

Retrieves workspace data by sending a GET request to the /api/v1/workspace endpoint. Requires a valid Bearer token in the Authorization header and the Accept header set to application/json.

```shell
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/workspace \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Scientific Notation Examples in HTML Number Inputs

Source: https://help.deftform.com/nice-to-know/using-the-number-type-for-short-answers

Demonstrates valid HTML5 number input values that utilize scientific notation. These inputs are compliant with the HTML5 specification for numeric fields.

```html
<input type="number" value="1.23e4"> <!-- 12,300 -->
<input type="number" value="5e-2"> <!-- 0,05 -->
<input type="number" value="1E+6"> <!-- 1,000,000 -->
```

--------------------------------

### Dynamic Parameters for Email Subject and Redirect URL

Source: https://help.deftform.com/nice-to-know/pre-fill-fields-via-url-parameter

This example illustrates using field parameters for dynamic content in email subjects, email bodies, and redirect URLs. Field identifiers (e.g., '###qqy1h###') are used as placeholders, which are replaced with respondent data. The '###UNIQUE_ID###' parameter can display the response ID with optional prefixes and suffixes. Values are URL-encoded when used in redirect URLs.

```URL
https://domain.com/thanks?name=###qqy1h###&email=###ezg3u###
```

--------------------------------

### Handle API Error Responses

Source: https://help.deftform.com/api/introduction

Example of a 403 Forbidden error response returned by the API. The response includes a success boolean and a descriptive message for debugging.

```json
{
  "success": false,
  "message": "You have no access to the requested resource"
}
```

--------------------------------

### GET /forms/{id}/fields

Source: https://help.deftform.com/api/endpoints

Retrieves the fields for a specific form using its ID. Requires an authorization token.

```APIDOC
## GET /forms/{id}/fields

### Description
Retrieves the fields for a specific form using its ID. Requires an authorization token.

### Method
GET

### Endpoint
/forms/{id}/fields

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the form.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/forms/YOUR_FORM_ID/fields \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **fields** (array) - An array of field objects for the specified form.

#### Response Example
```json
{
  "fields": [
    {
      "id": "field_uuid_1",
      "label": "Name",
      "type": "text"
    },
    {
      "id": "field_uuid_2",
      "label": "Message",
      "type": "textarea"
    }
  ]
}
```
```

--------------------------------

### Monitor API Rate Limits

Source: https://help.deftform.com/api/introduction

Demonstrates the HTTP headers returned by the API to track usage. The x-ratelimit-limit and x-ratelimit-remaining headers indicate current quota status.

```http
Status: 200 OK
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
```

--------------------------------

### Retrieve Forms and Fields via cURL

Source: https://help.deftform.com/api/endpoints

Fetches all forms and their associated fields. Requires a valid access token for authentication.

```shell
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/forms \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Workspace Access API

Source: https://help.deftform.com/api

This endpoint allows you to access your workspaces. Authentication is required.

```APIDOC
## GET /api/v1/Workspace

### Description
Retrieves access to a workspace. Requires authentication.

### Method
GET

### Endpoint
https://deftform.com/api/v1/Workspace

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your valid access token for authentication.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **workspace_id** (string) - The unique identifier for the workspace.
- **workspace_name** (string) - The name of the workspace.

#### Response Example
```json
{
  "workspace_id": "ws_123abc",
  "workspace_name": "My Workspace"
}
```
```

--------------------------------

### Generate Submission PDF via cURL

Source: https://help.deftform.com/api/endpoints

Retrieves a link to a PDF summary of a specific submission using the submission UUID. Requires a valid access token.

```shell
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/response/{UUID}/pdf \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Access Workspace Information

Source: https://help.deftform.com/api/introduction

Retrieve information about your Deftform workspace. This endpoint requires an authorization token.

```APIDOC
## GET /api/v1/workspace

### Description
Retrieves data about the authenticated user's workspace.

### Method
GET

### Endpoint
/api/v1/workspace

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://deftform.com/api/v1/workspace \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the workspace details.
  - **name** (string) - The name of the workspace.
  - **logo** (string|null) - URL to the workspace logo.
  - **logo_backend** (string|null) - URL to the backend logo.
  - **ogimage** (string|null) - URL to the Open Graph image.
  - **favicon** (string|null) - URL to the favicon.
  - **after_message** (string) - Message displayed after form submission.
  - **after_redirect_url** (string|null) - URL to redirect to after form submission.
  - **after_message_email_subject** (string|null) - Subject for the after-submission email.
  - **after_message_email** (string|null) - Content for the after-submission email.
  - **field_errormessage** (string) - Default error message for mandatory fields.
  - **slack_webhook_url** (string|null) - Slack webhook URL.
  - **discord_webhook_url** (string|null) - Discord webhook URL.
  - **webhook_secret** (string) - Secret key for webhooks.
  - **replyto_email** (string) - Reply-to email address.
  - **checkout_canceled_message** (string|null) - Message for canceled checkouts.
  - **checkout_canceled_cta** (string|null) - Call to action for canceled checkouts.
  - **onboarding_completed** (boolean) - Indicates if onboarding is completed.
  - **timezone** (string) - The workspace timezone.
  - **locale** (string) - The workspace locale.
  - **owner** (object) - Details about the workspace owner.
    - **name** (string) - Owner's name.
    - **email** (string) - Owner's email.
    - **email_verified_at** (string|null) - Timestamp when email was verified.
    - **two_factor_confirmed_at** (string|null) - Timestamp when 2FA was confirmed.
    - **created_at** (string) - Timestamp when the owner was created.
  - **members** (array) - List of workspace members.
  - **created_at** (string) - Timestamp when the workspace was created.

#### Response Example
```json
{
    "success": true,
    "data": {
        "name": "tinydub Forms",
        "logo": null,
        "logo_backend": null,
        "ogimage": null,
        "favicon": null,
        "after_message": "<p>Thank you, we'll be in touch.</p>",
        "after_redirect_url": null,
        "after_message_email_subject": null,
        "after_message_email": null,
        "field_errormessage": "This field is mandatory.",
        "slack_webhook_url": null,
        "discord_webhook_url": null,
        "webhook_secret": "PgJgzW3hdKCv",
        "replyto_email": "hello@tinydub.com",
        "checkout_canceled_message": null,
        "checkout_canceled_cta": null,
        "onboarding_completed": true,
        "timezone": "UTC",
        "locale": "de",
        "owner": {
            "name": "Andreas",
            "email": "user@example.com",
            "email_verified_at": "2024-03-28T20:08:58.000000Z",
            "two_factor_confirmed_at": null,
            "created_at": "2024-03-28T20:08:47.000000Z"
        },
        "members": [],
        "created_at": "2024-08-20T08:24:20.000000Z"
    }
}
```
```

--------------------------------

### API Authentication

Source: https://help.deftform.com/api/authentication

All API requests must include an Authorization header with a valid Bearer token. Access tokens can be generated in your workspace settings.

```APIDOC
## API Authentication

### Description
To connect to our API, you must use the `Authorization` header and use a valid access token. You can generate access tokens in your workspace settings.

### Method
All requests require authentication.

### Headers
- **Authorization** (string) - Required - `Bearer YOUR_ACCESS_TOKEN`
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Optional - `application/json`

### Request Example
```bash
curl https://deftform.com/api/v1/some_endpoint \
    -H "Authorization: Bearer t8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```
```

--------------------------------

### Rate Limiting

Source: https://help.deftform.com/api/introduction

Details on API rate limits and how to check your current status.

```APIDOC
### Rate Limiting

Users are limited to 60 requests per minute and 1,440 requests per day.

Rate limit status can be checked in the HTTP headers of API responses:

#### Rate Limit Headers Example
```
Status: 200 OK
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
```

To avoid hitting rate limits, consider implementing caching mechanisms in your application.
```

--------------------------------

### Manually Initialize or Re-initialize Deftform Forms (JavaScript)

Source: https://help.deftform.com/faq/how-to-embed-a-form-into-my-website

This JavaScript code snippet demonstrates how to manually initialize or re-initialize Deftform forms on a webpage. `window.initDeftform()` initializes all uninitialized forms, while `window.initDeftform(number)` targets a specific form by its DOM order. `window.reinitDeftform()` can be used to re-initialize forms.

```javascript
window.initDeftform();
window.initDeftform(2);
window.reinitDeftform();
```

--------------------------------

### Error Handling

Source: https://help.deftform.com/api/introduction

Information on how the API handles errors and the structure of error responses.

```APIDOC
### Errors

When an error is detected, the API returns an HTTP 4xx response. Common status codes include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).

#### Error Response Example (403 Forbidden)
```json
{
  "success": false,
  "message": "You have no access to the requested resource"
}
```

The `message` field provides details about the error. If no error message is returned, but a login page is encountered, ensure the `Accept: application/json` header is set.
```

--------------------------------

### POST /forms/{id}/settings

Source: https://help.deftform.com/api/endpoints

Updates specific settings for a given form. Partial updates are supported, meaning only the fields you wish to change need to be included in the request body.

```APIDOC
## POST /forms/{id}/settings

### Description
Updates specific settings for a form. You can provide only the fields you wish to modify.

### Method
POST

### Endpoint
/forms/{id}/settings

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the form.

#### Request Body
- **admin_email_attach_pdf** (boolean) - Optional
- **admin_email_note** (string) - Optional
- **admin_email_subject** (string) - Optional (max 255)
- **after_message** (string) - Optional
- **after_message_email** (string) - Optional
- **after_message_email_subject** (string) - Optional (max 255)
- **after_redirect_delay** (integer) - Optional (0-60)
- **after_redirect_url** (url) - Optional (max 500)
- **ai_summary_enabled** (boolean) - Optional
- **captcha** (string) - Optional ("altcha", "turnstile", "recaptcha", "none")
- **capture_location** (boolean) - Optional
- **closed_message** (string) - Optional
- **cta_label** (string) - Optional (max 100)
- **cta_label_continue** (string) - Optional (max 100)
- **description** (string) - Optional (max 1000)
- **discord_enabled** (boolean) - Optional
- **google_sheets_enabled** (boolean) - Optional
- **hubspot_enabled** (boolean) - Optional
- **include_response_in_email** (boolean) - Optional
- **is_closed** (boolean) - Optional
- **name** (string) - Optional (max 255)
- **number_prefix** (string) - Optional (max 10)
- **number_suffix** (string) - Optional (max 10)
- **responses_limit** (integer) - Optional (min 1)
- **send_pdf_to_respondent** (boolean) - Optional
- **seo_allow_bots** (boolean) - Optional
- **seo_description** (string) - Optional (max 500)
- **seo_title** (string) - Optional (max 255)
- **show_formtitle** (boolean) - Optional
- **show_multipage_progress** (boolean) - Optional
- **slack_enabled** (boolean) - Optional

### Request Example
{
    "name": "The new form name",
    "show_multipage_progress": true,
    "cta_label_continue": "Next question"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - Success message.
- **data** (object) - Contains "id", "name", and "updated_at".

#### Response Example
{
    "success": true,
    "message": "Form settings updated successfully.",
    "data": {
        "id": "KpCchh",
        "name": "Phone test 123",
        "updated_at": "2026-01-21T17:55:30.000000Z"
    }
}
```

--------------------------------

### Authenticate API requests using cURL

Source: https://help.deftform.com/api/authentication

Demonstrates how to authenticate a request to the Deftform API by including a Bearer token in the Authorization header. This method is required for all API endpoints and expects a JSON response.

```bash
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/... \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Retrieve Form Responses via cURL

Source: https://help.deftform.com/api/endpoints

Fetches all responses for a specific form using the form ID. Requires a valid access token.

```shell
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/responses/{formID} \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Default Embed Code for Deftform Forms (HTML)

Source: https://help.deftform.com/faq/how-to-embed-a-form-into-my-website

This is the recommended method for embedding forms. It involves adding a div element with specific data attributes and a script tag to load the embed script. The data attributes control width, height, alignment, and auto-height behavior. Forms initialize automatically on page load, but can be manually initialized or re-initialized using JavaScript.

```html
<div class="deftform" data-form-id="XXXX-XXXX-XXXX-XXXX" data-form-width="100%" data-form-align="center" data-form-auto-height="1"></div><script src="https://cdn.deftform.com/embed.js"></script>
```

--------------------------------

### Form Settings Update Success Response (JSON)

Source: https://help.deftform.com/api/endpoints

This JSON object shows the expected successful response after updating form settings. It includes a success status, a confirmation message, and a data object containing the form's ID, name, and the timestamp of the update.

```json
{
    "success": true,
    "message": "Form settings updated successfully.",
    "data": {
        "id": "KpCchh",
        "name": "Phone test 123",
        "updated_at": "2026-01-21T17:55:30.000000Z"
    }
}
```

--------------------------------

### Update Form Settings (JSON Request Body)

Source: https://help.deftform.com/api/endpoints

This JSON object represents the body of a POST request to update form settings. It includes fields like 'name', 'show_multipage_progress', and 'cta_label_continue'. Not all fields need to be included if only a subset is being modified.

```json
{
    "name": "The new form name",
    "show_multipage_progress": true,
    "cta_label_continue": "Next question"
}
```

--------------------------------

### Retrieve Specific Form Fields via cURL

Source: https://help.deftform.com/api/endpoints

Fetches fields for a specific form by providing the form ID in the URL path. Requires a valid access token.

```shell
$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';

curl https://deftform.com/api/v1/forms/{id}/fields \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
```

--------------------------------

### Workspace Data Response Payload

Source: https://help.deftform.com/api/introduction

A sample JSON response returned by the /api/v1/workspace endpoint. It contains workspace configuration, owner details, and metadata.

```json
{
    "success": true,
    "data": {
        "name": "tinydub Forms",
        "logo": null,
        "logo_backend": null,
        "ogimage": null,
        "favicon": null,
        "after_message": "<p>Thank you, we'll be in touch.</p>",
        "after_redirect_url": null,
        "after_message_email_subject": null,
        "after_message_email": null,
        "field_errormessage": "This field is mandatory.",
        "slack_webhook_url": null,
        "discord_webhook_url": null,
        "webhook_secret": "PgJgzW3hdKCv",
        "replyto_email": "hello@tinydub.com",
        "checkout_canceled_message": null,
        "checkout_canceled_cta": null,
        "onboarding_completed": true,
        "timezone": "UTC",
        "locale": "de",
        "owner": {
            "name": "Andreas",
            "email": "user@example.com",
            "email_verified_at": "2024-03-28T20:08:58.000000Z",
            "two_factor_confirmed_at": null,
            "created_at": "2024-03-28T20:08:47.000000Z"
        },
        "members": [],
        "created_at": "2024-08-20T08:24:20.000000Z"
    }
}
```

--------------------------------

### POST /forms/{id}/response

Source: https://help.deftform.com/api/endpoints

Adds a new response to a specific form. Useful for managing responses from custom forms.

```APIDOC
## POST /forms/{id}/response

### Description
Adds a new response to a specific form. Useful for managing responses from custom forms. File uploads are not supported directly; provide an absolute URL to an already uploaded file.

### Method
POST

### Endpoint
/forms/{id}/response

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the form to which the response will be added.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication
- **Accept** (string) - Optional - `application/json`
- **Content-Type** (string) - Required - `application/json`

#### Request Body
- **data** (object) - Required - An object where keys are field UUIDs and values are the corresponding response data (string or integer).

### Request Example
```json
{
  "data": {
    "00000000-1111-2222-3333-444444444444": "Custom value",
    "10000000-2111-3222-4333-544444444444": "Field value"
  }
}
```

### Response
#### Success Response (201)
- **response_id** (string) - The ID of the newly created response.

#### Response Example
```json
{
  "response_id": "new_response_uuid"
}
```
```
Tokens:
Raw