OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…

3 actions 3 updates phrasing extends openapi/onetrust-magic-link-tokens-v4-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/rest/api/consent/v4/datasubjects/linktokens'].get
$.paths['/rest/api/consent/v4/linktokens'].get

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 Consent & Preferences - Universal Consent & Preference…
  version: 1.0.0
extends: openapi/onetrust-magic-link-tokens-v4-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['/rest/api/consent/v4/datasubjects/linktokens'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject's magic link token
      effect: read
      questions:
      - How do I get the magic link token for one person's preference email?
      - Can I look up a link token by the data subject's identifier?
      instructions:
      - text: Get the magic link token for data subject {identifier}.
        slots:
          identifier: header.identifier
      - text: Fetch {identifier}'s email link token.
        slots:
          identifier: header.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/consent/v4/linktokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List magic link tokens in a date range
      effect: read
      questions:
      - Which magic link tokens were issued last week?
      - What is the longest date range I can list link tokens for?
      instructions:
      - text: List magic link tokens created from {fromDate} to {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Show all data subject link tokens issued between {fromDate} and {toDate}, sorted by {sort}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
          sort: query.sort
      method: generated
      generated: '2026-09-26'