Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise GDPR API

2 actions 2 updates phrasing extends openapi/qualified-com-gdpr-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Qualified's API. It is a proposal applied on top of the contract, not a document Qualified publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v2/gdpr_deletion_requests'].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 Qualified Enterprise GDPR API
  version: 1.0.0
extends: openapi/qualified-com-gdpr-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v2/gdpr_deletion_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request GDPR deletion of people by email
      effect: destructive
      questions:
      - How do I erase people's data from Qualified for a GDPR request?
      - How many email addresses can one GDPR deletion request contain?
      - What happens if one address in a GDPR deletion batch is malformed?
      instructions:
      - text: Submit a GDPR deletion request for {emails}.
        slots:
          emails: requestBody.emails
      - text: 'Permanently delete the personal data of these contacts under GDPR: {emails}.'
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'