Generated by API Evangelist
Written by API Evangelist tooling for Attentive's API. It is a proposal applied on top of the contract, not a document Attentive publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Attentive Subscribers API
version: 1.0.0
extends: openapi/attentive-subscribers-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: 3
- target: $.paths['/subscriptions'].get
update:
x-apievangelist-phrasing:
intent: Check a user's subscription eligibility
effect: read
questions:
- How do I check whether someone is subscribed to SMS or email?
- Can I look up a subscriber's subscription types by phone number?
- Is this customer eligible to receive marketing texts right now?
instructions:
- text: Show subscriptions for the user with phone {phone}.
slots:
phone: query.phone
- text: Check which channels {email} is subscribed to.
slots:
email: query.email
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions'].post
update:
x-apievangelist-phrasing:
intent: Subscribe a user
effect: write
questions:
- How do I opt a user into Attentive text messages through the API?
- Can I opt someone in without sending the reply Y confirmation text?
- Which sign-up source ID should I use when subscribing a user?
instructions:
- text: Subscribe {user} to {subscriptionType} messages.
slots:
user: requestBody.user
subscriptionType: requestBody.subscriptionType
- text: Opt in {user} using sign-up source {signUpSourceId}.
slots:
user: requestBody.user
signUpSourceId: requestBody.signUpSourceId
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/unsubscribe'].post
update:
x-apievangelist-phrasing:
intent: Unsubscribe a user
effect: destructive
questions:
- How do I unsubscribe someone from all messages?
- Can I unsubscribe a user from just email and keep SMS?
- Can I suppress the confirmation notification when unsubscribing a user?
instructions:
- text: Unsubscribe {user} from everything.
slots:
user: requestBody.user
- text: Unsubscribe {user} from {subscriptions} only.
slots:
user: requestBody.user
subscriptions: requestBody.subscriptions
method: generated
generated: '2026-09-26'
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.