Constant Contact · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for AppConnect V3 Technology Partners API
9 actions
9 updates
phrasing
extends
openapi/constant-contact-technology-partners-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Constant Contact's API. It is a proposal applied on top of the contract, not a document Constant Contact publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/partner/accounts'].get
$.paths['/partner/accounts'].post
$.paths['/partner/accounts/{encoded_account_id}/plan'].get
$.paths['/partner/accounts/{encoded_account_id}/plan'].put
$.paths['/partner/accounts/{encoded_account_id}/status/cancel'].put
$.paths['/partner/accounts/{encoded_account_id}/account_operations/sync'].post
$.paths['/partner/accounts/{encoded_account_id}/users/sso'].post
$.paths['/partner/accounts/{encoded_account_id}/contacts/unsubscribe'].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 AppConnect V3 Technology Partners API
version: 1.0.0
extends: openapi/constant-contact-technology-partners-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: 8
- target: $.paths['/partner/accounts'].get
update:
x-apievangelist-phrasing:
intent: List partner client accounts
effect: read
questions:
- Which client accounts are managed under my partner account?
- Can I filter client accounts by account type?
instructions:
- text: List my partner client accounts.
- text: List client accounts of type {account_type}.
slots:
account_type: query.account_type
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts'].post
update:
x-apievangelist-phrasing:
intent: Create a partner client account
effect: write
questions:
- Can I create a new client account for a customer as a partner?
- How long is the free trial on a newly provisioned account?
instructions:
- text: Create a client account for {contact_email} with login {login_name} in {state_code}, {country_code}.
slots:
contact_email: requestBody.contact_email
login_name: requestBody.login_name
state_code: requestBody.state_code
country_code: requestBody.country_code
- text: 'Provision {organization_name} as a client: email {contact_email}, login {login_name}, {state_code} {country_code}.'
slots:
organization_name: requestBody.organization_name
contact_email: requestBody.contact_email
login_name: requestBody.login_name
state_code: requestBody.state_code
country_code: requestBody.country_code
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/plan'].get
update:
x-apievangelist-phrasing:
intent: Get a client account's billing plan
effect: read
questions:
- What billing plan is a client account on?
- When is a client's billing day of the month?
instructions:
- text: Show the billing plan for client {encoded_account_id}.
slots:
encoded_account_id: path.encoded_account_id
- text: Get plan details for client account {encoded_account_id}.
slots:
encoded_account_id: path.encoded_account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/plan'].put
update:
x-apievangelist-phrasing:
intent: Change a client account's billing plan
effect: write
questions:
- Can I upgrade a client account to a different plan?
- Is it possible to change a client's billing day?
instructions:
- text: Switch client {encoded_account_id} to plan {plan_type}.
slots:
encoded_account_id: path.encoded_account_id
plan_type: requestBody.plan_type
- text: Set client {encoded_account_id} billing day to {billing_day_of_month}.
slots:
encoded_account_id: path.encoded_account_id
billing_day_of_month: requestBody.billing_day_of_month
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/status/cancel'].put
update:
x-apievangelist-phrasing:
intent: Cancel a client account
effect: destructive
questions:
- Can I cancel a client's account on a future date?
- What happens if I try to cancel a client under another partner?
instructions:
- text: Cancel client account {encoded_account_id}.
slots:
encoded_account_id: path.encoded_account_id
- text: Cancel client {encoded_account_id} effective {effective_date} for reason {reason_id}.
slots:
encoded_account_id: path.encoded_account_id
effective_date: requestBody.effective_date
reason_id: requestBody.reason_id
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/account_operations/sync'].post
update:
x-apievangelist-phrasing:
intent: Call the API on behalf of a client account
effect: write
questions:
- As a partner, can I make API calls as one of my client accounts?
- Which parts of the request do I specify when acting for a client?
instructions:
- text: On behalf of client {encoded_account_id}, send {account_operation_method} to {account_operation_url}.
slots:
encoded_account_id: path.encoded_account_id
account_operation_method: requestBody.account_operation_method
account_operation_url: requestBody.account_operation_url
- text: For client {encoded_account_id}, call {account_operation_method} {account_operation_url} with body {account_operation_payload}.
slots:
encoded_account_id: path.encoded_account_id
account_operation_method: requestBody.account_operation_method
account_operation_url: requestBody.account_operation_url
account_operation_payload: requestBody.account_operation_payload
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/users/sso'].post
update:
x-apievangelist-phrasing:
intent: Add a user to an SSO client account
effect: write
questions:
- Can I add a new user to a client account that uses single sign-on?
- What identity provider details do SSO users need?
instructions:
- text: Add SSO user {first_name} {last_name} as {role_name} to client {encoded_account_id}, email {contact_email}.
slots:
encoded_account_id: path.encoded_account_id
first_name: requestBody.first_name
last_name: requestBody.last_name
role_name: requestBody.role_name
contact_email: requestBody.contact_email
- text: Create SSO login {login_name} on client {encoded_account_id} linked to {external_id} at {external_provider}.
slots:
encoded_account_id: path.encoded_account_id
login_name: requestBody.login_name
external_id: requestBody.external_id
external_provider: requestBody.external_provider
method: generated
generated: '2026-10-01'
- target: $.paths['/partner/accounts/{encoded_account_id}/contacts/unsubscribe'].post
update:
x-apievangelist-phrasing:
intent: Unsubscribe contacts across client accounts
effect: destructive
questions:
- Can I unsubscribe an email address from every client account I manage?
- Is it possible to delete contacts while unsubscribing them?
instructions:
- text: Unsubscribe {email_addresses} from client {encoded_account_id}, source {update_source}.
slots:
encoded_account_id: path.encoded_account_id
email_addresses: requestBody.email_addresses
update_source: requestBody.update_source
- text: Globally unsubscribe {email_addresses} via client {encoded_account_id} ({global_unsubscribe}), source {update_source}.
slots:
encoded_account_id: path.encoded_account_id
email_addresses: requestBody.email_addresses
global_unsubscribe: requestBody.global_unsubscribe
update_source: requestBody.update_source
method: generated
generated: '2026-10-01'