Skip to navigation

Assign publication field values <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.

Assign one publication field’s value across many publications at once. Each key in values is a publication ID and each value is what that publication should resolve to. Sending null or an empty string removes the publication’s own value, leaving it to resolve to the field’s default value again.

Rows are written independently, so one rejected publication does not cost the rest of the batch. When any row is rejected the response is 207 and errors names the publications that were not written. A request that fails outright writes nothing at all.

Up to 2000 publications may be sent in a single request. Archived fields accept values, since their values still resolve in content. Fetched fields do not, since their values come from the configured endpoint.

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.
valuesmap from strings to optional stringsRequired
The value each publication should resolve to, keyed by prefixed publication ID. A null or empty value clears the publication's own value.

Response

OK
dataobject

Errors

207
Publication Field Values Partial Success Error
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error