Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Replies API

2 actions 2 updates phrasing extends openapi/agorapulse-replies-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Agorapulse's API. It is a proposal applied on top of the contract, not a document Agorapulse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1.0/inbox/organizations/{organizationId}/workspaces/{workspaceId}/accounts/{accountUid}/reply'].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 Agorapulse Replies API
  version: 1.0.0
extends: openapi/agorapulse-replies-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: 1
- target: $.paths['/v1.0/inbox/organizations/{organizationId}/workspaces/{workspaceId}/accounts/{accountUid}/reply'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to an inbox item
      effect: write
      questions:
      - How do I respond to a social media comment from my inbox through the API?
      - Can I answer a public comment with a private message instead?
      - Is there a way to exclude certain users from being mentioned in an X reply?
      instructions:
      - text: Reply {message} to inbox item {item} on account {account} in workspace {workspace}, org {org}.
        slots:
          message: requestBody.message
          item: requestBody.itemId
          account: path.accountUid
          workspace: path.workspaceId
          org: path.organizationId
      - text: Send a private reply {message} to the author of item {item} via account {account} (workspace {workspace}, org {org}).
        slots:
          message: requestBody.message
          item: requestBody.itemId
          account: path.accountUid
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'