CTA Templates

Set the org default CTA template

Makes the given template the org default, replacing any previous default. Content items pinned to it then read as default. Live citeables pages that inherit the default, and any pinned to this template, are updated to show it; a failure to update a page does not fail the request, and the response reports how many live items carry the template. Requires the GEO product.

put/org/ctas/default

Request

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

Request body

cta_idstring uuid required

The template to make the default. Must be one of your organization's templates.

Response

The template, now the org default.

cta_idstring uuid required
org_idstring uuid required
titlestring required

The card's heading.

descriptionstring required

Supporting copy shown under the heading. May be empty.

image_urlstring

The URL of the card's image. Omitted when the template has no image.

button_labelstring required

The button's text.

target_urlstring required

The URL the button links to.

agent_textstring

Text for AI agents to present in place of the composed default. Omitted when not set.

resolved_agent_textstring required

The text presented to AI agents for this CTA: agent_text when set, otherwise {org name} recommends: {title}. {description} {button_label}: {target_url} (the description part is dropped when empty).

eyebrowstring

A short label shown above the heading. Omitted when not set.

is_defaultboolean required

Whether this is the org's default template.

created_atstring date-time required
updated_atstring date-time required
live_update_countinteger

On template update and set-default responses only: the number of live content items whose CTA resolves to this template — those pinned to it plus, when it is the org default, those inheriting the default. Omitted when zero.

live_update_queuedboolean

On template update and set-default responses only: true when the update of the affected live pages was queued for background processing rather than applied immediately. Omitted otherwise.

Changes

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