Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive API V2 Bulk Segment Operations API

3 actions 3 updates phrasing extends openapi/attentive-bulk-segment-operations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/bulk/segments/members'].post

$.paths['/v2/bulk/segments/members'].delete

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 Attentive API V2 Bulk Segment Operations API
  version: 1.0.0
extends: openapi/attentive-bulk-segment-operations-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: 2
- target: $.paths['/v2/bulk/segments/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a segment in bulk
      effect: write
      questions:
      - How do I add thousands of subscribers to an Attentive segment in one request?
      - What is the maximum number of members I can add to a segment per bulk call?
      - Can I add people to a segment using just their client user ID instead of a phone or email?
      instructions:
      - text: Add these members {members} to segment {externalId}.
        slots:
          members: requestBody.members
          externalId: requestBody.externalId
      - text: Bulk add the attached list of emails and phone numbers to the segment with external ID {externalId}.
        slots:
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/bulk/segments/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove members from a segment in bulk
      effect: destructive
      questions:
      - How do I remove a large batch of people from an Attentive segment?
      - Can I take up to 10,000 members out of a segment in one request?
      - Is removing segment members in bulk processed asynchronously?
      instructions:
      - text: Remove these members {members} from segment {externalId}.
        slots:
          members: requestBody.members
          externalId: requestBody.externalId
      - text: Bulk remove the listed emails and phone numbers from the segment with external ID {externalId}.
        slots:
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'