# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Communication Preferences Subscriptions Status API
  version: 1.0.0
extends: openapi/hubspot-status-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/communication-preferences/2026-09/links/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate subscription preference links
      effect: write
      questions:
      - How do I get a manage-preferences or unsubscribe link for a specific subscriber?
      - Can the generated preference link be shown in the subscriber's language?
      instructions:
      - text: Generate {channel} preference and unsubscribe links for {subscriberIdString}.
        slots:
          channel: query.channel
          subscriberIdString: requestBody.subscriberIdString
      - text: Create a preference link for {subscriberIdString} on {channel} in {language}.
        slots:
          subscriberIdString: requestBody.subscriberIdString
          channel: query.channel
          language: requestBody.language
      method: generated
      generated: '2026-09-24'
- target: $.paths['/communication-preferences/2026-09/statuses/{subscriberIdString}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact's subscription preferences
      effect: read
      questions:
      - Which email subscriptions is a contact currently opted into?
      - Can I check a contact's preferences for one business unit only?
      instructions:
      - text: Show the {channel} subscription preferences for {subscriberIdString}.
        slots:
          channel: query.channel
          subscriberIdString: path.subscriberIdString
      - text: Get the subscriptions of {subscriberIdString} on {channel} in business unit {businessUnitId}.
        slots:
          subscriberIdString: path.subscriberIdString
          channel: query.channel
          businessUnitId: query.businessUnitId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/communication-preferences/2026-09/statuses/{subscriberIdString}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a contact's status for one subscription
      effect: write
      questions:
      - How do I subscribe or unsubscribe a contact from one specific email type?
      - Can I record the legal basis when changing a contact's subscription?
      instructions:
      - text: Set {subscriberIdString} to {statusState} for subscription {subscriptionId} on {channel}.
        slots:
          subscriberIdString: path.subscriberIdString
          statusState: requestBody.statusState
          subscriptionId: requestBody.subscriptionId
          channel: requestBody.channel
      - text: Subscribe {subscriberIdString} to subscription {subscriptionId} on {channel} under legal basis {legalBasis}.
        slots:
          subscriberIdString: path.subscriberIdString
          subscriptionId: requestBody.subscriptionId
          channel: requestBody.channel
          legalBasis: requestBody.legalBasis
      method: generated
      generated: '2026-09-24'
- target: $.paths['/communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a contact opted out of everything
      effect: read
      questions:
      - Has this contact unsubscribed from all emails?
      - What does an empty result mean when checking a contact's opt-out-of-all status?
      instructions:
      - text: Check whether {subscriberIdString} has opted out of all {channel} communications.
        slots:
          subscriberIdString: path.subscriberIdString
          channel: query.channel
      - text: Tell me if {subscriberIdString} is globally unsubscribed on {channel}.
        slots:
          subscriberIdString: path.subscriberIdString
          channel: query.channel
      method: generated
      generated: '2026-09-24'