Params

Param name Description
host_id
required

Id of the content host

Validations:

  • String

value
optional

Override to a boolean value or 'default'

Validations:

  • String

content_overrides
optional

Array of Content override parameters

Validations:

  • Must be an Array of nested elements

content_overrides[content_label]
required

Label of the content

Validations:

  • String

content_overrides[value]
optional

Override value. Provide a boolean value if name is 'enabled'

Validations:

  • String

content_overrides[name]
optional

Override key or name. Note if name is not provided the default name will be 'enabled'

Validations:

  • String

content_overrides[remove]
optional

Set true to remove an override and reset it to 'default'

Validations:

  • Must be one of: true, false, 1, 0.

content_overrides_search
optional

Content override search parameters

Validations:

  • Hash

content_overrides_search[search]
optional

Search string

Validations:

  • String

content_overrides_search[page]
optional

Page number, starting at 1

Validations:

  • Must be a number.

content_overrides_search[per_page]
optional

Number of results per page to return

Validations:

  • Must be a number.

content_overrides_search[order]
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

content_overrides_search[full_result]
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.

content_overrides_search[sort_by]
optional

Field to sort the results on

Validations:

  • String

content_overrides_search[sort_order]
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

content_overrides_search[enabled]
optional

Set true to override to enabled; Set false to override to disabled.'

Validations:

  • Must be one of: true, false, 1, 0.

content_overrides_search[remove]
optional

Set true to remove an override and reset it to 'default'

Validations:

  • Must be one of: true, false, 1, 0.