Brevo · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Loyalty Tier API
11 actions
11 updates
phrasing
extends
openapi/brevo-tier-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/loyalty/tier/programs/{pid}/tier-groups'].get
$.paths['/loyalty/tier/programs/{pid}/tier-groups'].post
$.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].get
$.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].put
$.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].delete
$.paths['/loyalty/tier/programs/{pid}/tiers'].get
$.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers'].post
$.paths['/loyalty/tier/programs/{pid}/tiers/{tid}'].put
$.paths['/loyalty/tier/programs/{pid}/tiers/{tid}'].delete
$.paths['/loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid}'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Loyalty Tier API
version: 1.0.0
extends: openapi/brevo-tier-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: 10
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups'].get
update:
x-apievangelist-phrasing:
intent: List tier groups
effect: read
questions:
- What tier groups are set up in my loyalty program?
- Can I see tier groups as of a specific program version?
instructions:
- text: List the tier groups in program {pid}.
slots:
pid: path.pid
- text: Show tier groups for program {pid} at version {version}.
slots:
pid: path.pid
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups'].post
update:
x-apievangelist-phrasing:
intent: Create a tier group
effect: write
questions:
- How do I set up a tier group like Silver, Gold and Platinum?
- When do new tier groups take effect in the program?
instructions:
- text: Create a tier group named {name} in program {pid}.
slots:
name: requestBody.name
pid: path.pid
- text: Create tier group {name} in program {pid} with upgrade strategy {upgradeStrategy}.
slots:
name: requestBody.name
pid: path.pid
upgradeStrategy: requestBody.upgradeStrategy
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].get
update:
x-apievangelist-phrasing:
intent: Get a tier group
effect: read
questions:
- What are the upgrade and downgrade rules for one tier group?
- Can I look up a single tier group's order of tiers?
instructions:
- text: Show tier group {gid} in program {pid}.
slots:
gid: path.gid
pid: path.pid
- text: Get tier group {gid} of program {pid} at version {version}.
slots:
gid: path.gid
pid: path.pid
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].put
update:
x-apievangelist-phrasing:
intent: Update a tier group
effect: write
questions:
- Can I change the downgrade strategy or tier order of an existing group?
- Do edits to a tier group apply immediately?
instructions:
- text: 'Update tier group {gid} in program {pid}: name {name}, order {tierOrder}, downgrade {downgradeStrategy}.'
slots:
gid: path.gid
pid: path.pid
name: requestBody.name
tierOrder: requestBody.tierOrder
downgradeStrategy: requestBody.downgradeStrategy
- text: Reorder tiers in group {gid} of program {pid}.
slots:
gid: path.gid
pid: path.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a tier group
effect: destructive
questions:
- Can I remove a whole tier group from my loyalty program?
- When does deleting a tier group take effect?
instructions:
- text: Delete tier group {gid} from program {pid}.
slots:
gid: path.gid
pid: path.pid
- text: Remove the tier group {gid} in loyalty program {pid}.
slots:
gid: path.gid
pid: path.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tiers'].get
update:
x-apievangelist-phrasing:
intent: List tiers
effect: read
questions:
- What tiers exist across my loyalty program?
- Can I see all tiers as of a program version?
instructions:
- text: List the tiers in program {pid}.
slots:
pid: path.pid
- text: Show all tiers of program {pid} at version {version}.
slots:
pid: path.pid
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers'].post
update:
x-apievangelist-phrasing:
intent: Create a tier in a tier group
effect: write
questions:
- How do I add a new level to a tier group with its entry conditions?
- Can a tier come with rewards attached?
instructions:
- text: Create tier {name} in group {gid} of program {pid} with access conditions {accessConditions}.
slots:
name: requestBody.name
gid: path.gid
pid: path.pid
accessConditions: requestBody.accessConditions
- text: Add a new tier to group {gid} in program {pid}.
slots:
gid: path.gid
pid: path.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tiers/{tid}'].put
update:
x-apievangelist-phrasing:
intent: Update a tier
effect: write
questions:
- Can I change the access conditions or rewards of an existing tier?
- Is it possible to rename a tier I already created?
instructions:
- text: 'Update tier {tid} in program {pid}: name {name}, conditions {accessConditions}, rewards {tierRewards}.'
slots:
tid: path.tid
pid: path.pid
name: requestBody.name
accessConditions: requestBody.accessConditions
tierRewards: requestBody.tierRewards
- text: Edit tier {tid} of program {pid}.
slots:
tid: path.tid
pid: path.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/tiers/{tid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a tier
effect: destructive
questions:
- Can I delete a single tier from a tier group?
- When does removing a tier take effect for members?
instructions:
- text: Delete tier {tid} from program {pid}.
slots:
tid: path.tid
pid: path.pid
- text: Remove tier {tid} in loyalty program {pid}.
slots:
tid: path.tid
pid: path.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid}'].post
update:
x-apievangelist-phrasing:
intent: Manually assign a tier to a member
effect: write
questions:
- How do I manually move a member into a specific tier?
- Can I override a member's tier regardless of conditions?
instructions:
- text: Assign tier {tid} to member {cid} in program {pid}.
slots:
tid: path.tid
cid: path.cid
pid: path.pid
- text: Put contact {cid} into tier {tid} of program {pid}.
slots:
cid: path.cid
tid: path.tid
pid: path.pid
method: generated
generated: '2026-09-26'