---
title: "Save one or many Hive bot field values, shared by every automation, by field id or by name. Send one field and its value, or fields for up to 20 at once. Every value is checked before any is saved."
method: POST
path: "/api/v1/tools/set_bot_fields"
---

# Save one or many Hive bot field values, shared by every automation, by field id or by name. Send one field and its value, or fields for up to 20 at once. Every value is checked before any is saved.

`POST /api/v1/tools/set_bot_fields`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/set_bot_fields`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `fieldId` string: The bot field to set. Bot field ids come from read_bot_fields.
  - `fieldName` string: The bot field’s key or name, instead of fieldId.
  - `value` union: The value to store in the field.
    - string
    - number
    - boolean
  - `fields` object[]: Up to 20 bot fields to set in one call, instead of one field and value.
    - `fieldId` string: The bot field to set.
    - `fieldName` string: The bot field’s key or name, instead of fieldId.
    - `value` union, required: The value to store.
      - string
      - number
      - boolean

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hivepublish/apis/hive-developer-api.md) · [All operations](https://skmtc.dev/hivepublish/apis/hive-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hivepublish/apis/hive-developer-api/revisions/b440c763583e?raw)