Skip to navigation
API ReferencePublication Fields

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

Currently in beta

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationFieldIdstringRequiredformat: "^(pub_field_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication field object

Request

This endpoint expects an object.
displaystringOptional
The human readable label for the field.
default_valuestringOptional
The value used for publications that have not set one of their own.
endpoint_urlstringOptional
The URL the value is retrieved from. Only supported for fetched fields. May contain merge tags that resolve per publication.
response_keyslist of objectsOptional

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.

statusenumOptional

Set to archived to archive the field, or active to restore it. Left unchanged when omitted.

Allowed values:

Response

OK
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error