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 User Defined Fields API
version: 1.0.0
extends: openapi/avalara-userdefinedfields-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/companies/{companyId}/userdefinedfields/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a user defined field
effect: destructive
questions:
- How do I remove a custom user defined field from a company?
- Is a deleted user defined field marked deleted?
instructions:
- text: Delete user defined field {id} from company {companyId}.
slots:
id: path.id
companyId: path.companyId
- text: Mark custom field {id} of company {companyId} as deleted.
slots:
id: path.id
companyId: path.companyId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/userdefinedfields'].get
update:
x-apievangelist-phrasing:
intent: List a company's user defined fields
effect: read
questions:
- Which custom user defined fields does my company have?
- Can I see all UDFs set up for one company?
instructions:
- text: List user defined fields for company {companyId}.
slots:
companyId: path.companyId
- text: Show every custom field defined on company {companyId}.
slots:
companyId: path.companyId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/userdefinedfields'].post
update:
x-apievangelist-phrasing:
intent: Update a company's user defined field
effect: write
questions:
- How do I change a user defined field on a company?
- Can I edit the definition of an existing custom field?
instructions:
- text: Update a user defined field for company {companyId}.
slots:
companyId: path.companyId
- text: Save changes to a custom field on company {companyId}.
slots:
companyId: path.companyId
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.