Generated by API Evangelist
Written by API Evangelist tooling for Act! CRM's API. It is a proposal applied on top of the contract, not a document Act! CRM publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for act.web.api Marketing Automations API
version: 1.0.0
extends: openapi/act-marketingautomations-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/contacts/{id}/campaign-results'].get
update:
x-apievangelist-phrasing:
intent: Get a contact's campaign results
effect: read
questions:
- How did one contact engage with my email campaigns?
- Can I see opens and clicks for a single contact?
instructions:
- text: Show campaign results for contact {id}.
slots:
id: path.id
- text: Get the email engagement results of contact {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/contacts/{id}/campaigns'].get
update:
x-apievangelist-phrasing:
intent: List campaigns a contact received
effect: read
questions:
- Which campaigns has a given contact been sent?
- Can I list the marketing campaigns tied to one contact?
instructions:
- text: List campaigns for contact {id}.
slots:
id: path.id
- text: Show which marketing campaigns contact {id} is part of.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/MarketingAutomations'].post
update:
x-apievangelist-phrasing:
intent: Record a marketing automation email
effect: write
questions:
- Can I log a marketing email sent from an outside campaign tool?
- How do I record opens and clicks for a campaign email?
instructions:
- text: Record email {emailId} from campaign {campaignId} named {campaignName}.
slots:
emailId: requestBody.emailId
campaignId: requestBody.campaignId
campaignName: requestBody.campaignName
- text: Log email {emailId} of campaign {campaignName} ({campaignId}) with subject {subject} sent to {receiverEmail}.
slots:
emailId: requestBody.emailId
campaignName: requestBody.campaignName
campaignId: requestBody.campaignId
subject: requestBody.subject
receiverEmail: requestBody.receiverEmail
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.