Attentive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attentive Custom Attributes API

3 actions 3 updates phrasing extends openapi/attentive-custom-attributes-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['/attributes/custom'].get

$.paths['/attributes/custom'].post

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 Custom Attributes API
  version: 1.0.0
extends: openapi/attentive-custom-attributes-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['/attributes/custom'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's custom attributes
      effect: read
      questions:
      - How do I see all the custom attributes stored for one subscriber?
      - Can I look up a user's custom attribute data by email instead of phone?
      - Why do I get an error when passing both phone and email to look up custom attributes?
      instructions:
      - text: Show the custom attributes for the user with email {email}.
        slots:
          email: query.email
      - text: Get custom attribute data for phone number {phone}.
        slots:
          phone: query.phone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attributes/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Set custom attributes on a user
      effect: write
      questions:
      - How do I save custom properties like favorite category on a user in Attentive?
      - Is there a limit to how many custom attributes I can create through the API?
      - Can I add a new value to a property that was created in the Attentive UI?
      instructions:
      - text: Set custom attributes {properties} on user {user}.
        slots:
          properties: requestBody.properties
          user: requestBody.user
      - text: Tag the shopper with email in {user} with a custom attribute of shoe size 10.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-09-26'