Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit Accounts API

7 actions 7 updates phrasing extends openapi/convertkit-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Kit's API. It is a proposal applied on top of the contract, not a document Kit publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v4/account'].get
$.paths['/v4/account/colors'].get
$.paths['/v4/account/colors'].put
$.paths['/v4/account/creator_profile'].get
$.paths['/v4/account/email_stats'].get
$.paths['/v4/account/growth_stats'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kit Accounts API
  version: 1.0.0
extends: openapi/convertkit-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v4/account'].get
  update:
    x-apievangelist-phrasing:
      intent: View the current account and user
      effect: read
      questions:
      - Which Kit account is my API key or OAuth token connected to?
      - Can I see the account name and primary user email for the current login?
      - What plan and account details come back for the credentials I'm using?
      instructions:
      - text: Show me the account and user that my current credentials belong to.
      - text: Confirm which email marketing account this integration is authorized for.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/account/colors'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's saved brand colors
      effect: read
      questions:
      - What brand colors are saved on my newsletter account?
      - Can I read back the hex color codes configured for my account's emails?
      instructions:
      - text: List the brand color hex codes currently saved on my account.
      - text: Show me my account's saved color palette.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/account/colors'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the account's brand colors
      effect: write
      questions:
      - How do I change the saved brand colors on my account?
      - Is there a limit to how many hex color codes I can save for my brand palette?
      instructions:
      - text: Set my account's brand colors to {colors}.
        slots:
          colors: requestBody.colors
      - text: 'Replace my saved color palette with these hex codes: {colors}.'
        slots:
          colors: requestBody.colors
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/account/creator_profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's public creator profile
      effect: read
      questions:
      - What does my public creator profile look like through the API?
      - Can I fetch the creator profile details readers see for my newsletter?
      instructions:
      - text: Show me my public creator profile.
      - text: Pull the creator profile information for my account.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/account/email_stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account-wide email performance stats
      effect: read
      questions:
      - What are my overall open and click rates across the emails I've sent?
      - Can I see account-level email stats like sends, opens and clicks?
      instructions:
      - text: Show me the email performance stats for my whole account.
      - text: Report my account's recent email sending, open and click numbers.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/account/growth_stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscriber growth stats for a date range
      effect: read
      questions:
      - How many subscribers did I gain and lose over the last 90 days?
      - Can I get list growth numbers for a custom date range?
      - Which time zone are the growth stats reported in?
      instructions:
      - text: Show my subscriber growth stats from {starting} to {ending}.
        slots:
          starting: query.starting
          ending: query.ending
      - text: Report my list growth since {starting}.
        slots:
          starting: query.starting
      - text: Give me my subscriber growth for the default last 90 days.
      method: generated
      generated: '2026-10-02'