Publication Custom Field Options
Manage selectable options for publication custom fields.
Create option
Creates a custom-field option for the addressed selection field.
path Parameters
idCreate option › Request Body
nameChoice option name.
Required on create. null is invalid.
externalIdChoice option ID in the external system.
Omit or set null to leave it unset on create.
Create option › Responses
Option created
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Get options by date
Returns the options the addressed publication custom field is configured for on the given date. This endpoint supports only publication custom fields of type SINGLE_SELECTION or MULTIPLE_SELECTION. An empty list means the date has no option subset, so the custom field is unrestricted on that date. Any date can be read, including past dates and dates beyond the window the corresponding PUT accepts; a subset for such a date is therefore read-only.
path Parameters
iddateGet options by date › Responses
OK
Options configured for the requested date. An empty list means the date has no option subset, so the custom field is unrestricted on that date.
Replace options by date
Replaces the option subset configured for the addressed date. This endpoint supports only publication custom fields of type SINGLE_SELECTION or MULTIPLE_SELECTION. The replacement is complete: options missing from the payload lose that date, and an empty list clears the subset so the custom field becomes unrestricted on that date. optionIds is required: an omitted field and an explicit null are both rejected. The date must be from the current date in UTC through the next N days, inclusive, where N is configured by the deployment. The response lists the options the date is configured for and is empty once the subset is cleared. Existing publication assignments on that date are not re-validated by this endpoint.
path Parameters
iddateReplace options by date › Request Body
optionIdsOptions available on the addressed date. Full replacement: options missing from the list lose the date, and an empty list clears the subset so that every option of the custom field becomes available again.
Required. An omitted field and null are both invalid.
Replace options by date › Responses
OK
Options configured for the requested date. An empty list means the date has no option subset, so the custom field is unrestricted on that date.
Replace options by date and external ID
Replaces the option subset configured for the addressed date, addressing options by external id. This endpoint supports only publication custom fields of type SINGLE_SELECTION or MULTIPLE_SELECTION. The replacement is complete: options missing from the payload lose that date, and an empty list clears the subset so the custom field becomes unrestricted on that date. optionExternalIds is required: an omitted field and an explicit null are both rejected. An external id shared by several options of the custom field resolves to the option with the lowest id, matching the other external-id endpoints. The date must be from the current date in UTC through the next N days, inclusive, where N is configured by the deployment. The response lists the options the date is configured for and is empty once the subset is cleared. Existing publication assignments on that date are not re-validated by this endpoint.
path Parameters
iddateReplace options by date and external ID › Request Body
optionExternalIdsExternal ids of the options available on the addressed date. Full replacement: options missing from the list lose the date, and an empty list clears the subset so that every option of the custom field becomes available again.
Required. An omitted field and null are both invalid.
Replace options by date and external ID › Responses
OK
Options configured for the requested date. An empty list means the date has no option subset, so the custom field is unrestricted on that date.
Get option by external ID
path Parameters
idexternalIdGet option by external ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Replace option by external ID
Replaces the addressed custom-field option.
path Parameters
idexternalIdReplace option by external ID › Request Body
nameChoice option name.
null is invalid.
externalIdChoice option ID in the external system.
Omit or set null to clear it.
Replace option by external ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Update option by external ID
Partially updates the addressed custom-field option.
path Parameters
idexternalIdUpdate option by external ID › Request Body
externalIdOption ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameOption name.
Omit to leave it unchanged. null is invalid.
Update option by external ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Get option by ID
path Parameters
idoptionIdGet option by ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Replace option by ID
Replaces the addressed custom-field option.
path Parameters
idoptionIdReplace option by ID › Request Body
nameChoice option name.
null is invalid.
externalIdChoice option ID in the external system.
Omit or set null to clear it.
Replace option by ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.
Update option by ID
Partially updates the addressed custom-field option.
path Parameters
idoptionIdUpdate option by ID › Request Body
externalIdOption ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameOption name.
Omit to leave it unchanged. null is invalid.
Update option by ID › Responses
OK
externalIdChoice option ID in the external system.
idChoice option ID.
nameChoice option name.
visibilityDatesDates this option is explicitly included in a restricted subset (yyyy-MM-dd). Availability is resolved per date: on a date that has a restricted subset only the options listed for that date are available, and on a date without a subset every option of the custom field is available. Omitted when the option is pinned to no date. Managed through the option-subset endpoints only.