Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced Identifiers API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/schema/identifiers'].post
$.paths['/identifiers'].post
$.paths['/identifiers/{field_name}'].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 Advanced Identifiers API
  version: 1.0.0
extends: openapi/optimizely-identifiers-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: 3
- target: $.paths['/schema/identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer identifier for user resolution
      effect: write
      questions:
      - How do I add a new identifier type, like a loyalty number, to Optimizely Data Platform?
      - What naming suffixes are allowed for a new identifier field?
      - Can a new identifier be used to merge customer profiles or to message customers?
      instructions:
      - text: Create identifier {name} displayed as {display_name} with {merge_confidence} merge confidence.
        slots:
          name: requestBody.name
          display_name: requestBody.display_name
          merge_confidence: requestBody.merge_confidence
      - text: Add identifier {name} ({display_name}), merge confidence {merge_confidence}, usable for messaging set to {messaging}.
        slots:
          name: requestBody.name
          display_name: requestBody.display_name
          merge_confidence: requestBody.merge_confidence
          messaging: requestBody.messaging
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Update metadata for an identifier
      effect: write
      questions:
      - Can I update the metadata attached to a customer identifier value?
      - Is there an endpoint to push identifier metadata changes into ODP?
      instructions:
      - text: Update the metadata for an identifier.
      - text: Push new identifier metadata into the data platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identifiers/{field_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for an identifier
      effect: read
      questions:
      - What metadata does ODP hold for a specific email address?
      - Can I look up an identifier's metadata by its field name and value?
      instructions:
      - text: Get metadata for the {field_name} identifier.
        slots:
          field_name: path.field_name
      - text: Look up metadata for {field_name} value {id}.
        slots:
          field_name: path.field_name
          id: query.id
      method: generated
      generated: '2026-09-26'