Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive Identity API

2 actions 2 updates phrasing extends openapi/attentive-identity-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 2

$.info
$.paths['/identity-resolution/user-identifiers'].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 Attentive Identity API
  version: 1.0.0
extends: openapi/attentive-identity-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: 1
- target: $.paths['/identity-resolution/user-identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a client user ID or custom identifiers to a user
      effect: write
      questions:
      - How do I connect my own customer ID to a subscriber's phone or email?
      - Can I associate a Shopify or Klaviyo ID with an existing user?
      - What other identifier must accompany a custom identifier when linking a user?
      instructions:
      - text: Associate client user ID {clientUserId} with email {email}.
        slots:
          clientUserId: requestBody.clientUserId
          email: requestBody.email
      - text: Link custom identifiers {customIdentifiers} to the user with phone {phone}.
        slots:
          customIdentifiers: requestBody.customIdentifiers
          phone: requestBody.phone
      - text: Tie Shopify ID {shopifyId} to client user ID {clientUserId}.
        slots:
          shopifyId: requestBody.shopifyId
          clientUserId: requestBody.clientUserId
      method: generated
      generated: '2026-09-26'