# 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 Consent Receipts API
  version: 1.0.0
extends: openapi/onetrust-consent-receipts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/consentreceipts'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a consent receipt from a collection point
      effect: write
      questions:
      - How do I record that someone just gave or withdrew consent through a collection point?
      - Can I send a test consent receipt without storing a real transaction?
      - What purposes and data elements can a single consent receipt carry?
      instructions:
      - text: Record a standard collection-point consent receipt (not the identified variant) for {identifier} with request token {requestInformation}.
        slots:
          identifier: requestBody.identifier
          requestInformation: requestBody.requestInformation
      - text: Submit a general consent receipt for {identifier} to purposes {purposes} using collection point token {requestInformation}.
        slots:
          identifier: requestBody.identifier
          purposes: requestBody.purposes
          requestInformation: requestBody.requestInformation
      method: generated
      generated: '2026-10-02'
- target: $.paths['/consentreceipts/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Import consent receipts in bulk
      effect: write
      questions:
      - How do I import a large backlog of consent transactions efficiently?
      - Is there a bulk endpoint for loading many consent receipts at once?
      instructions:
      - text: Bulk import consent receipts for {identifier} with request token {requestInformation}.
        slots:
          identifier: requestBody.identifier
          requestInformation: requestBody.requestInformation
      - text: Load historical consent dated {interactionDate} for {identifier} in bulk via token {requestInformation}.
        slots:
          interactionDate: requestBody.interactionDate
          identifier: requestBody.identifier
          requestInformation: requestBody.requestInformation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consentreceipts/identified'].post
  update:
    x-apievangelist-phrasing:
      intent: Record consent for an identified data subject
      effect: write
      questions:
      - How do I record consent for a known user identified by email rather than a cookie?
      - Which consent receipt endpoint is meant for non-cookie collection points?
      instructions:
      - text: Record an identified consent receipt for {identifier} of type {identifierType} using token {requestInformation}.
        slots:
          identifier: requestBody.identifier
          identifierType: requestBody.identifierType
          requestInformation: requestBody.requestInformation
      - text: Log non-cookie consent for known user {identifier} with request token {requestInformation}.
        slots:
          identifier: requestBody.identifier
          requestInformation: requestBody.requestInformation
      method: generated
      generated: '2026-09-26'