Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Contact Users API

5 actions 5 updates phrasing extends openapi/conga-contact-users-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/user-management/v1/contact-users'].post

$.paths['/api/user-management/v1/contact-users/{userId}'].put

$.paths['/api/user-management/v1/contact-users/{userId}'].delete

$.paths['/api/user-management/v1/contact-users/{userId}/restore'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for User Management Contact Users API
  version: 1.0.0
extends: openapi/conga-contact-users-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: 4
- target: $.paths['/api/user-management/v1/contact-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user for a contact
      effect: write
      questions:
      - Can I give an external contact a user login mapped to their contact record?
      - Can I set role and permission groups when creating a contact user?
      instructions:
      - text: Create a contact user for {email} linked to contact {contact}.
        slots:
          email: requestBody.Email
          contact: requestBody.ContactObjectId
      - text: Add a contact user {first} {last} with role {role}.
        slots:
          first: requestBody.FirstName
          last: requestBody.LastName
          role: requestBody.Role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/contact-users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact user
      effect: write
      questions:
      - Can I change a contact user's timezone or locale?
      - Can I update the permission groups of a contact user?
      instructions:
      - text: Update contact user {user}.
        slots:
          user: path.userId
      - text: Change the email of contact user {user} to {email}.
        slots:
          user: path.userId
          email: requestBody.Email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/contact-users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a contact user
      effect: destructive
      questions:
      - How do I deactivate a contact user's access?
      - Does removing a contact user delete them or just deactivate them?
      instructions:
      - text: Deactivate contact user {user}.
        slots:
          user: path.userId
      - text: Turn off access for contact user {user}.
        slots:
          user: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/contact-users/{userId}/restore'].put
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a contact user
      effect: write
      questions:
      - Can I bring back a contact user I deactivated earlier?
      - How do I restore a deactivated contact user?
      instructions:
      - text: Reactivate contact user {user}.
        slots:
          user: path.userId
      - text: Restore the deactivated contact user {user}.
        slots:
          user: path.userId
      method: generated
      generated: '2026-10-01'