Update publication field
update_publication_fieldUpdate a publication field's label, status, endpoint, default value, or response keys. This changes account state and needs confirm=true.
Instructions
Update publication field. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require publication_fields:write.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"publication_field_id": "<publication_field_id>"
},
"name": "update_publication_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Set to `archived` to archive the field, or `active` to restore it. Left unchanged when omitted. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| display | No | The human readable label for the field. | |
| payload | No | Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file. | |
| endpoint_url | No | The URL the value is retrieved from. Only supported for fetched fields. May contain merge tags that resolve per publication. | |
| payload_file | No | Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged. | |
| default_value | No | The value used for publications that have not set one of their own. | |
| response_keys | No | ||
| publication_field_id | Yes | The prefixed ID of the publication field object |