Generated by API Evangelist
Written by API Evangelist tooling for Encharge's API. It is a proposal applied on top of the contract, not a document Encharge publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Encharge Segments API
version: 1.0.0
extends: openapi/encharge-segments-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: 4
- target: $.paths['/segments'].get
update:
x-apievangelist-phrasing:
intent: List dynamic segments
effect: read
questions:
- What segments have I set up?
- How do I list all my dynamic segments?
instructions:
- text: List all my segments.
- text: Show every dynamic segment in the account.
method: generated
generated: '2026-10-01'
- target: $.paths['/segments'].post
update:
x-apievangelist-phrasing:
intent: Create a dynamic segment
effect: write
questions:
- How do I create a segment of contacts that match certain conditions?
- Can I build a segment for companies instead of people?
instructions:
- text: Create a segment named {name} with conditions {conditions}.
slots:
name: requestBody.name
conditions: requestBody.conditions
- text: Create a {objectName} segment called {name}.
slots:
objectName: requestBody.objectName
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/segments/{segmentId}/people'].get
update:
x-apievangelist-phrasing:
intent: List people in a segment
effect: read
questions:
- How do I get the contacts who are in a specific segment?
- Can I leave out anonymous people when listing a segment's members?
instructions:
- text: List the people in segment {segmentId}.
slots:
segmentId: path.segmentId
- text: Show {limit} contacts from segment {segmentId} with fields {attributes}.
slots:
limit: query.limit
segmentId: path.segmentId
attributes: query.attributes
method: generated
generated: '2026-10-01'
- target: $.paths['/segments/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Modify a dynamic segment
effect: write
questions:
- How do I change the conditions of an existing segment?
- Can I rename a segment or change its color?
instructions:
- text: Change the conditions of segment {id} to {conditions}.
slots:
id: path.id
conditions: requestBody.conditions
- text: Rename segment {id} to {name}.
slots:
id: path.id
name: requestBody.name
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.