Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Bulk Actions.sequence Subscriptions API

4 actions 4 updates phrasing extends openapi/close-bulk-actions-sequence-subscriptions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/bulk_action/sequence_subscription/'].get

$.paths['/bulk_action/sequence_subscription/'].post

$.paths['/bulk_action/sequence_subscription/{id}/'].get

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 Close Bulk Actions.sequence Subscriptions API
  version: 1.0.0
extends: openapi/close-bulk-actions-sequence-subscriptions-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: 3
- target: $.paths['/bulk_action/sequence_subscription/'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk sequence subscription jobs
      effect: read
      questions:
      - What bulk sequence enrollments have we run?
      - Can I page through past bulk sequence jobs?
      instructions:
      - text: List our bulk sequence subscription jobs.
      - text: Show the latest {limit} bulk sequence jobs.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/sequence_subscription/'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk subscribe, pause or resume sequences
      effect: write
      questions:
      - How do I enroll every contact in a search into a sequence?
      - Can I resume paused sequence subscriptions in bulk?
      instructions:
      - text: Subscribe all contacts in this Smart View to our nurture sequence.
      - text: Resume every paused sequence subscription for these leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/sequence_subscription/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk sequence subscription job
      effect: read
      questions:
      - Has my bulk sequence enrollment finished?
      - How do I check one bulk sequence job's status?
      instructions:
      - text: Show bulk sequence subscription {id}.
        slots:
          id: path.id
      - text: Check the progress of bulk sequence job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'