> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.beehiiv.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.beehiiv.com/_mcp/server.

# Update publication field <Badge intent="info" minimal outlined>OAuth Scope: publication_fields:write</Badge>

PATCH https://api.beehiiv.com/v2/workspaces/publication_fields/{publicationFieldId}
Content-Type: application/json

This feature is currently in beta and the API is subject to change.

Update a publication field, or archive it by setting `status` to `archived`. Archiving hides the field from the workspace library, and content that already references it keeps resolving. `name`, `kind` and `value_source` cannot be changed once the field exists, because content may already reference it. Removing a key from `response_keys` stops every `{{pub.<name>.<key>}}` tag that used it from resolving. Requires an API key with access to every publication in the workspace.

Reference: https://developers.beehiiv.com/api-reference/publication-fields/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `publicationFieldId` (string, required) — The prefixed ID of the publication field object

### Body (application/json)

This endpoint expects an object.

- `display` (string, optional) — The human readable label for the field.
- `default_value` (string, optional) — The value used for publications that have not set one of their own.
- `endpoint_url` (string, optional) — The URL the value is retrieved from. Only supported for fetched fields. May contain merge tags that resolve per publication.
- `response_keys` (list of PublicationFieldResponseKey, optional) — The keys declared within the fetched JSON response body. Replaces the existing list. Only supported for `json` fields. A `number` or `date` key also claims its format variants, so a key `temp_round2` is rejected with `RESPONSE_KEYS_CLASHES` beside a `number` key named `temp`.
- `status` (enum, optional) — Set to `archived` to archive the field, or `active` to restore it. Left unchanged when omitted.
  - Allowed values: `active`, `archived`

## Response

### 200

OK

- `data` (PublicationField, required)

## Errors

### 400 Bad Request Error

Bad Request

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 401 Unauthorized Error

Unauthorized. The API key or OAuth access token is missing, invalid, or expired.

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 403 Forbidden Error

Forbidden

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 404 Not Found Error

Resource Not Found

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 500 Internal Server Error

Internal Server Error

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

## Types

### PublicationFieldResponseKey

- `key` (string, required) — The name of the key within the JSON response body.
- `kind` (enum, required) — The type of value the key holds.
  - Allowed values: `text`, `number`, `date`, `url`, `image_url`

### PublicationField

- `id` (string, required) — The prefixed ID of the publication field.
- `name` (string, required) — The merge tag key for the field. This is what content references, and it is unique within the workspace.
- `display` (string, required) — The human readable label for the field.
- `kind` (enum, required) — The type of value the field holds.
  - Allowed values: `text`, `number`, `boolean`, `date`, `color`, `url`, `image_url`, `rss_feed_url`, `json`
- `value_source` (enum, required) — Where the value for each publication comes from.
  - Allowed values: `static`, `fetched`
- `response_keys` (list of PublicationFieldResponseKey, required) — The keys declared within the fetched JSON response body. Empty unless `kind` is `json`.
- `status` (enum, required) — Whether the field is currently active or has been archived.
  - Allowed values: `active`, `archived`
- `created` (integer, required) — The time the field was created. Measured in seconds since the Unix epoch.
- `updated` (integer, required) — The time the field was last updated. Measured in seconds since the Unix epoch.
- `default_value` (string, optional) — The value used for publications that have not set one of their own. Null when the field has none configured; `json` and `rss_feed_url` fields are the only kinds not required to have one.
- `endpoint_url` (string, optional) — The URL the value is retrieved from. Present only when `value_source` is `fetched`, and may contain merge tags that resolve per publication.

### ErrorDetail

- `message` (string, required)
- `code` (string, required)

## Examples

**Request**

```json
{
  "status": "archived"
}
```

**Response**

```json
{
  "data": {
    "id": "pub_field_00000000-0000-0000-0000-000000000000",
    "name": "support_email",
    "display": "Support email",
    "kind": "text",
    "value_source": "static",
    "response_keys": [],
    "status": "archived",
    "created": 1700000000,
    "updated": 1700000000,
    "default_value": "support@beehiiv.com",
    "endpoint_url": null
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000"

payload = { "status": "archived" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"status":"archived"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000"

	payload := strings.NewReader("{\n  \"status\": \"archived\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"archived\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"archived\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000', [
  'body' => '{
  "status": "archived"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"status\": \"archived\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["status": "archived"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beehiiv.com/v2/workspaces/publication_fields/pub_field_00000000-0000-0000-0000-000000000000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> Build your audience with beehiiv's API and SDKs. Create new subscribers and posts, get real-time notifications of subscription activity, and more.