Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Customer User Profiles API

10 actions 10 updates phrasing extends openapi/optimizely-customer-user-profiles-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 10

$.info
$.paths['/api/v1/admin/CustomerUserProfiles'].get
$.paths['/api/v1/admin/CustomerUserProfiles'].post
$.paths['/api/v1/admin/CustomerUserProfiles({id})'].get
$.paths['/api/v1/admin/CustomerUserProfiles({id})'].put
$.paths['/api/v1/admin/CustomerUserProfiles({id})'].delete
$.paths['/api/v1/admin/CustomerUserProfiles({id})'].patch
$.paths['/api/v1/admin/CustomerUserProfiles/Default.Default()'].get
$.paths['/api/v1/admin/customeruserprofiles/delete'].delete
$.paths['/api/v1/admin/customeruserprofiles({key})/customproperties({custompropertyKey})'].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 Admin API V1 Customer User Profiles API
  version: 1.0.0
extends: openapi/optimizely-customer-user-profiles-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: 9
- target: $.paths['/api/v1/admin/CustomerUserProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer-to-user assignments
      effect: read
      questions:
      - Which user profiles are linked to which customer accounts?
      - Can I filter customer user assignments to one customer?
      instructions:
      - text: List all customer user profile links.
      - text: List customer user profiles matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a user to a customer account
      effect: write
      questions:
      - How do I give a user profile access to a customer account?
      - What IDs does it take to link a user to a customer?
      instructions:
      - text: Link user profile {userProfileId} to customer {customerId}.
        slots:
          userProfileId: requestBody.userProfileId
          customerId: requestBody.customerId
      - text: Assign customer {customerId} to user {userProfileId}.
        slots:
          customerId: requestBody.customerId
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer-to-user assignment
      effect: read
      questions:
      - Can I look up one customer and user link by its ID?
      - Which fields can I expand on a single customer user profile record?
      instructions:
      - text: Show customer user profile link {id}.
        slots:
          id: path.id
      - text: Get customer user profile {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a customer-to-user assignment
      effect: write
      questions:
      - Can I overwrite a customer user link with a different pairing?
      - What's the full-replace call for a customer user profile?
      instructions:
      - text: Replace link {id} so user {userProfileId} maps to customer {customerId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
          customerId: requestBody.customerId
      - text: Overwrite customer user profile {id} with customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a customer account
      effect: destructive
      questions:
      - How do I take away a user's access to one customer account?
      - Can I delete a customer user link only if its ETag matches?
      instructions:
      - text: Delete customer user profile link {id}.
        slots:
          id: path.id
      - text: Remove customer user link {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a customer-to-user assignment
      effect: write
      questions:
      - Can I move a link to a different customer without resending everything?
      - Is there a partial update for a customer user profile?
      instructions:
      - text: Point customer user link {id} at customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      - text: Patch customer user link {id} to user {userProfileId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerUserProfiles/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a customer user link
      effect: read
      questions:
      - What defaults are pre-filled for a new customer user profile?
      - Is there a blank template for linking users to customers?
      instructions:
      - text: Get the default customer user profile template.
      - text: Show pre-filled values for a new customer-to-user link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customeruserprofiles/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several customer-to-user assignments
      effect: destructive
      questions:
      - Can I bulk remove customer user links in one call?
      - Which call deletes many customer user profiles by ID?
      instructions:
      - text: Bulk delete customer user profile links {ids}.
        slots:
          ids: query.ids
      - text: Remove the customer-to-user assignments {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customeruserprofiles({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a customer user link
      effect: read
      questions:
      - Can I read a custom field stored on a customer user profile?
      - Where are extra attributes of a customer-to-user link kept?
      instructions:
      - text: Get custom property {custompropertyKey} on customer user profile {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show customer user link {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'