Generated by API Evangelist
Written by API Evangelist tooling for Avalara's API. It is a proposal applied on top of the contract, not a document Avalara publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Avalara AvaTax Notifications API
version: 1.0.0
extends: openapi/avalara-notifications-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: 3
- target: $.paths['/api/v2/notifications/{id}/dismiss'].put
update:
x-apievangelist-phrasing:
intent: Dismiss a notification
effect: write
questions:
- How do I dismiss a notification once I've dealt with it?
- Can I clear an Avalara notice from my list after addressing it?
instructions:
- text: Dismiss notification {id}.
slots:
id: path.id
- text: Mark notification {id} as handled and dismissed.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/notifications/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one notification
effect: read
questions:
- Can I read the full details of a single notification?
- What does a specific notification say about my business?
instructions:
- text: Get notification {id}.
slots:
id: path.id
- text: Show the message in notification {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/notifications'].get
update:
x-apievangelist-phrasing:
intent: List my notifications
effect: read
questions:
- What notifications has Avalara sent me?
- Are there any messages I still need to review?
instructions:
- text: List all my notifications.
- text: Show notifications I haven't reviewed yet.
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.