---
title: "Board Form Batch Action"
method: POST
path: "/v3.0/boards/{boardSlug}/forms/"
tags: ["boards"]
---

# Board Form Batch Action

`POST /v3.0/boards/{boardSlug}/forms/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/boards/{boardSlug}/forms/`
- Auth: none declared. Required headers: `x-api-key`

## Activate/Deactivate user field on boards

Please note that if the board does not have the `user_field` set on it, you cannot use this endpoint.
User should have edit access to the board and all the forms in the request body.

Example for request body:

``` json
[
    {
        "form": "U0D6enFH",
        "user_field_enabled": true
    },
    {
        "form": "QMfXqwGP",
        "user_field_enabled": false
    },
    {
        "form": "m8fLr193",
        "user_field_enabled": true
    },
    {
        "form": "05xGZrdrBsUteWH",
        "user_field_enabled": false
    }
]
```

Example of request response:


``` json
{
    "status": 201,
    "errors": {
        "general_errors": [],
        "form_errors": {}
    },
    "data": {
        "forms": [
            {
                "slug": "U0D6enFH",
                "has_user_field": true
            },
            {
                "slug": "QMfXqwGP",
                "has_user_field": false
            },
            {
                "slug": "m8fLr193",
                "has_user_field": true
            },
            {
                "slug": "05xGZrdrBsUteWH",
                "has_user_field": false
            }
        ]
    }
}
```

The forms on which the `has_user_field` is set to `true`, backend will ensure that they have a user field directed to the `user_form` of the board, and if they don't have it, it will be created. 

The forms on which the `has_user_field` is set to `false`, backend will ensure that they don't have a user field directed to the `user_form` of the board, and if they don have it, it will be deleted.

## Path parameters

- `boardSlug` string, required

## Headers

- `x-api-key` string, required
- `x-workspace` string

## Request body

- BoardFormBatchActionRequest
  - `form` string, required: Slug of the form that we want to add/remove the user field on.
  - `user_field_enabled` boolean, required: If the user field is enabled on the form or not.

## Response `201`

- BoardFormBatchAction
  - `slug` string, nullable
  - `has_user_field` string

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)