Content

Set a content item's CTA selection

Sets the call-to-action (CTA) a content-engine content item carries when it is published. selection_type is default to inherit the org's default template, template to pin a specific template (cta_id required), or none to publish without a CTA; cta_id must be omitted for default and none. Pinning the template that is currently the org default is stored as default. The selection is a full replacement, and the response is the resulting selection with the template it resolves to. If the item is already live on a citeables destination, the live page's CTA is updated to match; a failure to update a live page does not fail the request. Only content-engine content has a CTA selection; other content items return 404. Requires the GEO product.

put/org/content/{id}/cta

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

The content item's id.

Request body

selection_type'default' | 'template' | 'none' required

default inherits the org's default CTA template, template pins the template named by cta_id, and none publishes without a CTA.

cta_idstring uuid

The CTA template to pin. Required when selection_type is template and must be omitted otherwise. Must be one of your organization's templates.

Response

The content item's CTA selection after the change.

content_idstring uuid required
org_idstring uuid required
selection_type'default' | 'template' | 'none' required

default (the org's default template), template (a pinned template), or none (no CTA). An item whose selection has never been set reports default. A pinned template that later becomes the org default reads back as default, and items that were live and using the org default when that default was cleared read none.

cta_idstring uuid

The pinned template's id. Present only when selection_type is template.

updated_bystring uuid

The user who last set the selection. Present only when a user last set it; omitted when the selection has never been set, was last set with an API key, or was last changed automatically.

created_atstring date-time

When the selection was first set. Omitted when it has never been set.

updated_atstring date-time

When the selection was last changed. Omitted when it has never been set.

Changes

No recorded changes to this operation across all 1 revision of this API.