ActiveCampaign · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for ActiveCampaign API v3 Tasks API
12 actions
12 updates
phrasing
extends
openapi/activecampaign-tasks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/taskOutcomes'].get
$.paths['/taskOutcomes'].post
$.paths['/taskOutcomes/{id}'].get
$.paths['/taskOutccomes/{id}'].put
$.paths['/taskOutccomes/{id}'].delete
$.paths['/tasktypeOutcomeRels'].get
$.paths['/tasktypeOutcomeRels'].post
$.paths['/tasktypeOutcomeRels/{id}'].get
$.paths['/tasktypeOutcomeRels/{id}'].put
$.paths['/tasktypeOutcomeRels/{id}'].delete
$.paths['/taskNotifications'].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 ActiveCampaign API v3 Tasks API
version: 1.0.0
extends: openapi/activecampaign-tasks-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: 11
- target: $.paths['/taskOutcomes'].get
update:
x-apievangelist-phrasing:
intent: List task outcomes
effect: read
questions:
- What outcomes can a completed CRM task be marked with?
- Can I list only the task outcomes with a negative sentiment?
instructions:
- text: List all task outcomes.
- text: Show task outcomes with sentiment {sentiment}.
slots:
sentiment: query.filters[sentiment]
method: generated
generated: '2026-09-26'
- target: $.paths['/taskOutcomes'].post
update:
x-apievangelist-phrasing:
intent: Create a task outcome
effect: write
questions:
- How do I add a new outcome like 'Left voicemail' for tasks?
- Can I give a task outcome a positive or negative sentiment?
instructions:
- text: Create a task outcome called {title} with sentiment {sentiment}.
slots:
title: requestBody.title
sentiment: requestBody.sentiment
- text: 'Add the outcome {title} as {sentiment}, disabled: {disabled}.'
slots:
title: requestBody.title
sentiment: requestBody.sentiment
disabled: requestBody.disabled
method: generated
generated: '2026-09-26'
- target: $.paths['/taskOutcomes/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a task outcome
effect: read
questions:
- What title and sentiment does a specific task outcome have?
- Can I look up one task outcome by ID?
instructions:
- text: Show task outcome {id}.
slots:
id: path.id
- text: Get the details of outcome {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/taskOutccomes/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a task outcome
effect: write
questions:
- Can I rename a task outcome or change its sentiment?
- How do I disable a task outcome we no longer use?
instructions:
- text: Update task outcome {id} to title {title} and sentiment {sentiment}.
slots:
id: path.id
title: requestBody.title
sentiment: requestBody.sentiment
- text: Set task outcome {id} as {title}, {sentiment}, disabled {disabled}.
slots:
id: path.id
title: requestBody.title
sentiment: requestBody.sentiment
disabled: requestBody.disabled
method: generated
generated: '2026-09-26'
- target: $.paths['/taskOutccomes/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a task outcome
effect: destructive
questions:
- How do I permanently remove a task outcome?
- Can I delete an outcome option from the task list?
instructions:
- text: Delete task outcome {id}.
slots:
id: path.id
- text: Remove outcome {id} from the task outcomes.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/tasktypeOutcomeRels'].get
update:
x-apievangelist-phrasing:
intent: List task type to outcome links
effect: read
questions:
- Which outcomes are available for each task type?
- Can I see how task types map to outcomes?
instructions:
- text: List all task type to outcome relations.
- text: Show which outcomes are tied to each task type.
method: generated
generated: '2026-09-26'
- target: $.paths['/tasktypeOutcomeRels'].post
update:
x-apievangelist-phrasing:
intent: Link an outcome to a task type
effect: write
questions:
- How do I make an outcome available for a particular task type?
- Can I create a new task type and outcome relation?
instructions:
- text: Create a task type outcome relation titled {title} with sentiment {sentiment}.
slots:
title: requestBody.title
sentiment: requestBody.sentiment
- text: Relate outcome {title} ({sentiment}) to a task type.
slots:
title: requestBody.title
sentiment: requestBody.sentiment
method: generated
generated: '2026-09-26'
- target: $.paths['/tasktypeOutcomeRels/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a task type to outcome link
effect: read
questions:
- What task type and outcome does a single relation connect?
- Can I look up one task type outcome relation by ID?
instructions:
- text: Show task type outcome relation {id}.
slots:
id: path.id
- text: Get the task type to outcome link {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/tasktypeOutcomeRels/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a task type to outcome link
effect: write
questions:
- Can I change which task type an outcome relation points to?
- How do I edit an existing task type outcome relation?
instructions:
- text: Update task type outcome relation {id} with task type {dealTasktype}.
slots:
id: path.id
dealTasktype: requestBody.dealTasktype
- text: Edit the task type to outcome link {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/tasktypeOutcomeRels/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove an outcome from a task type
effect: destructive
questions:
- How do I stop an outcome from being offered for a task type?
- Can I delete a task type to outcome relation?
instructions:
- text: Delete task type outcome relation {id}.
slots:
id: path.id
- text: Unlink the outcome in relation {id} from its task type.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/taskNotifications'].post
update:
x-apievangelist-phrasing:
intent: Set a reminder for a deal task
effect: write
questions:
- Can I get reminded before a deal task is due?
- How do I schedule a notification for a CRM task?
instructions:
- text: Remind me about task {dealTask} {interval} before it is due.
slots:
dealTask: requestBody.dealTask
interval: requestBody.interval
- text: Create a task reminder for deal task {dealTask} at interval {interval}.
slots:
dealTask: requestBody.dealTask
interval: requestBody.interval
method: generated
generated: '2026-09-26'