# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Templates API
  version: 1.0.0
extends: openapi/iterable-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 29
- target: $.paths['/api/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List project templates with filters
      effect: read
      questions:
      - Can I list only my SMS templates, or only blast templates?
      - Which templates were created in a certain date range?
      instructions:
      - text: List {messageMedium} templates of type {templateType}.
        slots:
          messageMedium: query.messageMedium
          templateType: query.templateType
      - text: List templates created between {startDateTime} and {endDateTime}, page {page}.
        slots:
          startDateTime: query.startDateTime
          endDateTime: query.endDateTime
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/bulkDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete base templates
      effect: destructive
      questions:
      - Can I delete several templates at once?
      - Will templates attached to a campaign be deleted in a bulk delete?
      instructions:
      - text: Delete templates {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk remove base templates {ids} that aren't used by campaigns.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/email/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template in a locale
      effect: read
      questions:
      - Can I fetch the Spanish version of an email template?
      - What's the rate limit for reading email templates under /api/templates?
      instructions:
      - text: Get email template {templateId} in locale {locale}.
        slots:
          templateId: query.templateId
          locale: query.locale
      - text: Fetch /api email template {templateId}.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/email/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Render an email template preview with custom data
      effect: read
      questions:
      - Can I see the rendered HTML of an email template with sample data before sending?
      - Will the email preview pull in data feeds?
      instructions:
      - text: Preview email template {templateId} with data {dataFields}.
        slots:
          templateId: query.templateId
          dataFields: requestBody.dataFields
      - text: Render email template {templateId} in {locale}, fetching data feeds {fetchDataFeeds}.
        slots:
          templateId: query.templateId
          locale: query.locale
          fetchDataFeeds: requestBody.fetchDataFeeds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/email/proof'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email template proof
      effect: write
      questions:
      - How do I send myself a test email of a template?
      - Can I send a proof email with custom data fields to a teammate?
      instructions:
      - text: Send a proof of email template {templateId} to {recipientEmail}.
        slots:
          templateId: requestBody.templateId
          recipientEmail: requestBody.recipientEmail
      - text: Email a proof of template {templateId} to user {recipientUserId} with data {dataFields}.
        slots:
          templateId: requestBody.templateId
          recipientUserId: requestBody.recipientUserId
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/email/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an email template's full settings
      effect: write
      questions:
      - Can I change an email template's CC, BCC and reply-to addresses?
      - Is it possible to attach data feeds or a message type when updating an email template?
      instructions:
      - text: Set the subject of email template {templateId} to {subject}.
        slots:
          templateId: requestBody.templateId
          subject: requestBody.subject
      - text: Update email template {templateId} to reply to {replyToEmail} and BCC {bccEmails}.
        slots:
          templateId: requestBody.templateId
          replyToEmail: requestBody.replyToEmail
          bccEmails: requestBody.bccEmails
      - text: Attach data feeds {dataFeedIds} to email template {templateId}.
        slots:
          dataFeedIds: requestBody.dataFeedIds
          templateId: requestBody.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/email/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an email template by client ID
      effect: write
      questions:
      - How do I create an email template that updates if it already exists?
      - Will upserting an email template update every template with the same name?
      instructions:
      - text: Upsert email template {clientTemplateId} named {name} with subject {subject}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          name: requestBody.name
          subject: requestBody.subject
      - text: Create email template {clientTemplateId} with HTML {html} from {fromEmail}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          html: requestBody.html
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/embedded/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an embedded message template
      effect: read
      questions:
      - Can I fetch an embedded message template by ID?
      - Is there a localized version of my embedded template?
      instructions:
      - text: Get embedded template {templateId}.
        slots:
          templateId: query.templateId
      - text: Fetch embedded template {templateId} in locale {locale}.
        slots:
          templateId: query.templateId
          locale: query.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/embedded/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an embedded message template
      effect: write
      questions:
      - Can I change the title, body or placement of an embedded template?
      - Is it possible to update an embedded template's buttons and elements?
      instructions:
      - text: Set embedded template {templateId} title to {title}.
        slots:
          templateId: requestBody.templateId
          title: requestBody.title
      - text: Update embedded template {templateId} body to {body} and placement {placementId}.
        slots:
          templateId: requestBody.templateId
          body: requestBody.body
          placementId: requestBody.placementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/embedded/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an embedded template by client ID
      effect: write
      questions:
      - How do I create an embedded message template that updates if it already exists?
      - Can a new embedded template target a specific placement?
      instructions:
      - text: Upsert embedded template {clientTemplateId} titled {title}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          title: requestBody.title
      - text: Create embedded template {clientTemplateId} for placement {placementId} with body {body}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          placementId: requestBody.placementId
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/getByClientTemplateId'].get
  update:
    x-apievangelist-phrasing:
      intent: Find email templates by client template ID
      effect: read
      questions:
      - Can I look up an email template using my own client template ID?
      - Which Iterable template matches the ID my system assigned?
      instructions:
      - text: Find the template with client template ID {clientTemplateId}.
        slots:
          clientTemplateId: query.clientTemplateId
      - text: Look up templates by my ID {clientTemplateId}.
        slots:
          clientTemplateId: query.clientTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/inapp/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app template in a locale
      effect: read
      questions:
      - Can I fetch a localized in-app template under /api/templates?
      - Where do I read an in-app template's content in another language?
      instructions:
      - text: Get in-app template {templateId} in locale {locale}.
        slots:
          templateId: query.templateId
          locale: query.locale
      - text: Fetch /api in-app template {templateId}.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/inapp/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Render an in-app template preview with custom data
      effect: read
      questions:
      - Can I preview how an in-app message renders with sample data?
      - Does the in-app preview support pulling data feeds?
      instructions:
      - text: Preview in-app template {templateId} with data {dataFields}.
        slots:
          templateId: query.templateId
          dataFields: requestBody.dataFields
      - text: Render in-app template {templateId} using data feed {dataFeed}.
        slots:
          templateId: query.templateId
          dataFeed: requestBody.dataFeed
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/inapp/proof'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an in-app template proof
      effect: write
      questions:
      - How do I send a test in-app message of a template to my device?
      - Can I send an in-app proof with custom data to a test user?
      instructions:
      - text: Send a proof of in-app template {templateId} to {recipientEmail}.
        slots:
          templateId: requestBody.templateId
          recipientEmail: requestBody.recipientEmail
      - text: Send in-app proof of template {templateId} to user {recipientUserId} in locale {locale}.
        slots:
          templateId: requestBody.templateId
          recipientUserId: requestBody.recipientUserId
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/inapp/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an in-app template
      effect: write
      questions:
      - Can I change when an in-app template expires?
      - Is it possible to update in-app display settings or inbox metadata?
      instructions:
      - text: Set in-app template {templateId} to expire at {expirationDateTime}.
        slots:
          templateId: requestBody.templateId
          expirationDateTime: requestBody.expirationDateTime
      - text: Update in-app template {templateId} HTML to {html}.
        slots:
          templateId: requestBody.templateId
          html: requestBody.html
      - text: Change inbox metadata of in-app template {templateId} to {inboxMetadata}.
        slots:
          templateId: requestBody.templateId
          inboxMetadata: requestBody.inboxMetadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/inapp/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an in-app template by client ID
      effect: write
      questions:
      - How do I create an in-app template that updates if it already exists?
      - Can a new in-app template set its expiration duration?
      instructions:
      - text: Upsert in-app template {clientTemplateId} named {name} with HTML {html}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          name: requestBody.name
          html: requestBody.html
      - text: Create in-app template {clientTemplateId} expiring after {expirationDuration}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          expirationDuration: requestBody.expirationDuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/push/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a push template in a locale
      effect: read
      questions:
      - Can I fetch a localized push template under /api/templates?
      - What's the rate limit on reading push templates?
      instructions:
      - text: Get push template {templateId} in locale {locale}.
        slots:
          templateId: query.templateId
          locale: query.locale
      - text: Fetch /api push template {templateId}.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/push/proof'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push template proof
      effect: write
      questions:
      - How do I send a test push of a template to my phone?
      - Can a push proof use custom data fields?
      instructions:
      - text: Send a proof of push template {templateId} to {recipientEmail}.
        slots:
          templateId: requestBody.templateId
          recipientEmail: requestBody.recipientEmail
      - text: Send push proof of template {templateId} to user {recipientUserId} with data {dataFields}.
        slots:
          templateId: requestBody.templateId
          recipientUserId: requestBody.recipientUserId
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/push/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a push template
      effect: write
      questions:
      - Can I change a push template's deep link, sound or badge?
      - Is it possible to make a push template silent or set its interruption level?
      instructions:
      - text: Set push template {templateId} message to {message} with title {title}.
        slots:
          templateId: requestBody.templateId
          message: requestBody.message
          title: requestBody.title
      - text: Update push template {templateId} deep link to {deeplink}.
        slots:
          templateId: requestBody.templateId
          deeplink: requestBody.deeplink
      - text: Make push template {templateId} silent {isSilentPush}.
        slots:
          templateId: requestBody.templateId
          isSilentPush: requestBody.isSilentPush
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/push/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a push template by client ID
      effect: write
      questions:
      - How do I create a push template that updates if one with that name exists?
      - Can a new push template include buttons and rich media?
      instructions:
      - text: Upsert push template {clientTemplateId} with message {message}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          message: requestBody.message
      - text: Create push template {clientTemplateId} titled {title} with rich media {richMedia}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          title: requestBody.title
          richMedia: requestBody.richMedia
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/sms/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS template in a locale
      effect: read
      questions:
      - Can I fetch a localized SMS template under /api/templates?
      - Where do I read an SMS template's text in another language?
      instructions:
      - text: Get SMS template {templateId} in locale {locale}.
        slots:
          templateId: query.templateId
          locale: query.locale
      - text: Fetch /api SMS template {templateId}.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/sms/proof'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS template proof
      effect: write
      questions:
      - How do I text myself a test of an SMS template?
      - Can an SMS proof go to a test user with custom data?
      instructions:
      - text: Send a proof of SMS template {templateId} to {recipientEmail}.
        slots:
          templateId: requestBody.templateId
          recipientEmail: requestBody.recipientEmail
      - text: Text a proof of template {templateId} to user {recipientUserId} with data {dataFields}.
        slots:
          templateId: requestBody.templateId
          recipientUserId: requestBody.recipientUserId
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/sms/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an SMS template
      effect: write
      questions:
      - Can I change the text or image on an SMS template?
      - Is it possible to set a tracking domain on an SMS template?
      instructions:
      - text: Set SMS template {templateId} message to {message}.
        slots:
          templateId: requestBody.templateId
          message: requestBody.message
      - text: Update SMS template {templateId} image to {imageUrl} and tracking domain {trackingDomain}.
        slots:
          templateId: requestBody.templateId
          imageUrl: requestBody.imageUrl
          trackingDomain: requestBody.trackingDomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates/sms/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an SMS template by client ID
      effect: write
      questions:
      - How do I create an SMS template that updates if one with that name exists?
      - Can a new SMS template include an image?
      instructions:
      - text: Upsert SMS template {clientTemplateId} with message {message}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          message: requestBody.message
      - text: Create SMS template {clientTemplateId} named {name} with image {imageUrl}.
        slots:
          clientTemplateId: requestBody.clientTemplateId
          name: requestBody.name
          imageUrl: requestBody.imageUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/email/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template (simple)
      effect: read
      questions:
      - Is there a plain /templates/email/get call to read an email template by ID?
      - Which basic endpoint returns an email template's content and metadata?
      instructions:
      - text: Get email template {templateId} from the plain /templates endpoint.
        slots:
          templateId: query.templateId
      - text: Read email template {templateId} via the simple endpoint.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/email/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an email template's content (simple)
      effect: write
      questions:
      - Can I update just an email template's subject, HTML and sender via the basic /templates path?
      - Which simple call edits an email template's preheader text?
      instructions:
      - text: Using /templates/email/update, set template {templateId} subject to {subject}.
        slots:
          templateId: requestBody.templateId
          subject: requestBody.subject
      - text: Via the simple endpoint, update template {templateId} HTML to {html} and preheader to {preheaderText}.
        slots:
          templateId: requestBody.templateId
          html: requestBody.html
          preheaderText: requestBody.preheaderText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/push/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a push template (simple)
      effect: read
      questions:
      - Is there a plain /templates/push/get call to read a push notification template?
      - Which basic endpoint returns a push template's content?
      instructions:
      - text: Get push template {templateId} from the plain /templates endpoint.
        slots:
          templateId: query.templateId
      - text: Read push notification template {templateId} via the simple endpoint.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/sms/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS template (simple)
      effect: read
      questions:
      - Is there a plain /templates/sms/get call to read an SMS template?
      - Which basic endpoint returns an SMS template's text and metadata?
      instructions:
      - text: Get SMS template {templateId} from the plain /templates endpoint.
        slots:
          templateId: query.templateId
      - text: Read SMS template {templateId} via the simple endpoint.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/inApp/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app template (simple)
      effect: read
      questions:
      - Is there a plain /templates/inApp/get call to read an in-app template?
      - Which basic endpoint returns an in-app message template's content?
      instructions:
      - text: Get in-app template {templateId} from the plain /templates endpoint.
        slots:
          templateId: query.templateId
      - text: Read in-app message template {templateId} via the simple endpoint.
        slots:
          templateId: query.templateId
      method: generated
      generated: '2026-10-01'