# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Email Templates API
  version: 1.0.0
extends: openapi/optimizely-email-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 14
- target: $.paths['/api/v1/admin/EmailTemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List the email templates
      effect: read
      questions:
      - How can I see all the email templates set up in Commerce admin?
      - Can I filter the email template list by website?
      instructions:
      - text: List every email template.
      - text: Show the email templates matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new email template
      effect: write
      questions:
      - What do I need to supply to add a new email template?
      - Can I create an email template for a specific website?
      instructions:
      - text: Create an email template named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add email template {name} for website {websiteId} with description {description}.
        slots:
          name: requestBody.name
          websiteId: requestBody.websiteId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email template by id
      effect: read
      questions:
      - How do I open a single email template record?
      - What details are stored for one email template?
      instructions:
      - text: Fetch email template {id}.
        slots:
          id: path.id
      - text: Show me everything about email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email template record
      effect: write
      questions:
      - Can I replace an entire email template record in one request?
      - Does a full replace of an email template require the name and description again?
      instructions:
      - text: Replace email template {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite the whole email template {id} record.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single email template
      effect: destructive
      questions:
      - How do I delete one email template by id?
      - Can I guard an email template delete with an ETag check?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: path.id
      - text: Delete email template {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit part of an email template
      effect: write
      questions:
      - Can I just rename an email template without replacing it?
      - Is there a partial update for an email template's description?
      instructions:
      - text: Rename email template {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the description of email template {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new email template
      effect: read
      questions:
      - What values does a new email template record start with?
      - Is there a blank email template entity I can fill in?
      instructions:
      - text: Get the default field values for a new email template entity.
      - text: Show the blank email template record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates/Default.defaulttemplates()'].get
  update:
    x-apievangelist-phrasing:
      intent: List built-in default templates via OData action
      effect: read
      questions:
      - Which built-in default email templates ship with the platform, via the OData defaulttemplates function?
      - Can I call Default.defaulttemplates() to see the stock templates?
      instructions:
      - text: Call the OData defaulttemplates function to list stock email templates.
      - text: Show the built-in email templates using Default.defaulttemplates().
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailTemplates/Default.createdefaulttemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stock template via the OData action
      effect: write
      questions:
      - How do I install one of the built-in email templates for a website with the OData createdefaulttemplate action?
      - Can the Default.createdefaulttemplate action target a specific website?
      instructions:
      - text: Run createdefaulttemplate to add stock template {defaultTemplate} for website {websiteId}.
        slots:
          defaultTemplate: requestBody.defaultTemplate
          websiteId: requestBody.websiteId
      - text: Install the built-in email template {defaultTemplate} with the OData action.
        slots:
          defaultTemplate: requestBody.defaultTemplate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailtemplates/defaultTemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List built-in default templates via REST route
      effect: read
      questions:
      - Is there a plain REST route that lists the stock email templates?
      - What does the emailtemplates/defaultTemplates route return?
      instructions:
      - text: Get the default email templates from the defaultTemplates route.
      - text: List the stock email templates using the REST-style route.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailtemplates/createDefaultTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stock template via the REST route
      effect: write
      questions:
      - Can I create a default email template through the createDefaultTemplate REST route?
      - What does posting to emailtemplates/createDefaultTemplate do?
      instructions:
      - text: Create a default email template using the createDefaultTemplate route.
      - text: Post to the REST createDefaultTemplate endpoint to add a stock template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailtemplates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several email templates at once
      effect: destructive
      questions:
      - How do I bulk delete multiple email templates?
      - Can I remove a list of email templates by id in one call?
      instructions:
      - text: Bulk delete email templates {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove every email template in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailtemplates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an email template
      effect: read
      questions:
      - How do I read a custom property stored on an email template?
      - Can I fetch one custom field from an email template?
      instructions:
      - text: Get custom property {custompropertyKey} of email template {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the custom property {custompropertyKey} value on email template {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailtemplates({key})/emaillists({emaillistKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email list that uses a template
      effect: read
      questions:
      - Which email list is tied to a given email template?
      - Can I look up one email list through its template?
      instructions:
      - text: Get email list {emaillistKey} for email template {key}.
        slots:
          key: path.key
          emaillistKey: path.emaillistKey
      - text: Show the email list {emaillistKey} that uses template {key}.
        slots:
          key: path.key
          emaillistKey: path.emaillistKey
      method: generated
      generated: '2026-09-26'