IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Link Invitations API

5 actions 5 updates phrasing extends openapi/integration-os-link-invitations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/link-invitations/organizations/{org_id}'].get
$.paths['/v1/link-invitations/organizations/{org_id}'].post
$.paths['/v1/link-invitations/organizations/{org_id}/{id}'].delete
$.paths['/v1/link-invitations/organizations/{org_id}/{id}/resend'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One Link Invitations API
  version: 1.0.0
extends: openapi/integration-os-link-invitations-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: 4
- target: $.paths['/v1/link-invitations/organizations/{org_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer link invitations
      effect: read
      questions:
      - Which customers have I sent connect-link invitations to?
      - Can I filter link invitations by status to see who has not accepted?
      instructions:
      - text: List link invitations for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show org {org_id}'s link invitations with status {status}.
        slots:
          org_id: path.org_id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-invitations/organizations/{org_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a customer to connect via a link
      effect: write
      questions:
      - How do I email a customer an invitation to connect their accounts?
      - Can I send a connect link built from one of my link templates?
      instructions:
      - text: Send a link invitation to {customer_name} at {customer_email} using template {template_id} in org {org_id}.
        slots:
          customer_name: requestBody.customerName
          customer_email: requestBody.customerEmail
          template_id: requestBody.templateId
          org_id: path.org_id
      - text: Invite {customer_email} to connect in the {environment} environment, labelled {internal_name}, for org {org_id}, template {template_id}, name {customer_name}.
        slots:
          customer_email: requestBody.customerEmail
          environment: requestBody.environment
          internal_name: requestBody.internalName
          org_id: path.org_id
          template_id: requestBody.templateId
          customer_name: requestBody.customerName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-invitations/organizations/{org_id}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a customer link invitation
      effect: destructive
      questions:
      - How do I cancel a connect-link invitation I sent to a customer?
      - Can I stop a customer from using an invitation link that went to the wrong person?
      instructions:
      - text: Revoke link invitation {id} in organization {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      - text: Cancel the customer connect invitation {id} for org {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/link-invitations/organizations/{org_id}/{id}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a customer link invitation
      effect: write
      questions:
      - Can I resend a connect-link invitation a customer says they never got?
      - What do I do when a customer lost their invitation email?
      instructions:
      - text: Resend link invitation {id} in organization {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      - text: Email the customer connect invitation {id} again for org {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'