# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Link Branding API
  version: 1.0.0
extends: openapi/sendgrid-link-branding-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v3/whitelabel/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List all branded links
      effect: read
      questions:
      - Which link branding domains do I have set up?
      - Can I see every branded link on my account, or a subuser's?
      instructions:
      - text: List all my branded links.
      - text: Show up to {limit} branded links.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create link branding for a domain
      effect: write
      questions:
      - Can I make the tracked links in my emails use my own domain instead of the default one?
      - What root domain and subdomain do I need to set up link branding?
      instructions:
      - text: Create link branding for {domain}.
        slots:
          domain: requestBody.domain
      - text: Brand my email links with subdomain {subdomain} of {domain}.
        slots:
          subdomain: requestBody.subdomain
          domain: requestBody.domain
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one branded link
      effect: read
      questions:
      - Where can I see the DNS records and status of a specific branded link?
      - Is a particular link branding set as my default and is it valid?
      instructions:
      - text: Show branded link {id}.
        slots:
          id: path.id
      - text: Get the DNS details for link branding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a branded link
      effect: destructive
      questions:
      - Can I remove link branding I no longer use?
      - Will I get the branded link's details back when I delete it?
      instructions:
      - text: Delete branded link {id}.
        slots:
          id: path.id
      - text: Remove link branding {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a branded link's default status
      effect: write
      questions:
      - Can I make an existing branded link the default one used in my emails?
      - Is it possible to stop a link branding from being the default?
      instructions:
      - text: 'Set branded link {id} as default: {default}.'
        slots:
          id: path.id
          default: requestBody.default
      - text: Make link branding {id} my default link domain.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/{id}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a branded link's DNS
      effect: write
      questions:
      - I added the CNAMEs — can I check whether my link branding validates now?
      - Why isn't my branded link verified yet?
      instructions:
      - text: Validate branded link {id}.
        slots:
          id: path.id
      - text: Check the DNS records for link branding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/{link_id}/subuser'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a branded link to a subuser
      effect: write
      questions:
      - Can a subuser use the parent account's link branding?
      - What's the step to share one of my branded links with a subuser?
      instructions:
      - text: Assign branded link {link_id} to subuser {username}.
        slots:
          link_id: path.link_id
          username: requestBody.username
      - text: Let subuser {username} use link branding {link_id}.
        slots:
          username: requestBody.username
          link_id: path.link_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default branded link
      effect: read
      questions:
      - Which branded link is actually used when I send messages?
      - How is the default link branding chosen when I have more than one?
      instructions:
      - text: Show my default branded link.
      - text: Get the default link branding for {domain}.
        slots:
          domain: query.domain
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/subuser'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subuser's branded link
      effect: read
      questions:
      - What link branding has been assigned to a particular subuser?
      - Is a subuser sending with my parent account's branded links?
      instructions:
      - text: Show the branded link assigned to subuser {username}.
        slots:
          username: query.username
      - text: Get link branding for subuser {username}.
        slots:
          username: query.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/whitelabel/links/subuser'].delete
  update:
    x-apievangelist-phrasing:
      intent: Take a branded link away from a subuser
      effect: destructive
      questions:
      - Can I stop a subuser from using my account's link branding?
      - What's the way to unassign link branding from a subuser?
      instructions:
      - text: Remove the branded link from subuser {username}.
        slots:
          username: query.username
      - text: Unassign link branding from subuser {username}.
        slots:
          username: query.username
      method: generated
      generated: '2026-09-24'