Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Privacy REST Forget API

3 actions 3 updates phrasing extends openapi/listrak-forget-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/Forget/{requestId}'].get

$.paths['/v1/Forget'].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 Listrak Privacy REST Forget API
  version: 1.0.0
extends: openapi/listrak-forget-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['/v1/Forget/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a forget request's status
      effect: read
      questions:
      - Has my data deletion (forget) request finished processing?
      - How do I check the status of a privacy forget request I submitted?
      instructions:
      - text: Get the status of forget request {requestId}.
        slots:
          requestId: path.requestId
      - text: Check whether forget request {requestId} has completed.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Forget'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a request to forget a person
      effect: destructive
      questions:
      - How do I erase someone's personal data for a privacy request?
      - Can I submit a forget request using a phone number instead of an email?
      instructions:
      - text: Submit a forget request for {emailAddress}.
        slots:
          emailAddress: requestBody.emailAddress
      - text: Queue a request to forget the person with phone number {phoneNumber}.
        slots:
          phoneNumber: requestBody.phoneNumber
      method: generated
      generated: '2026-09-26'