Generated by API Evangelist
Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for MOVEit Transfer REST Contacts API
version: 1.0.0
extends: openapi/progress-software-contacts-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/v1/contacts'].get
update:
x-apievangelist-phrasing:
intent: List and search address book contacts
effect: read
questions:
- Which contacts are in my MOVEit Transfer address book?
- Can I search contacts by name or email and sort by email?
instructions:
- text: List my contacts.
- text: Search contacts for {searchString}, sorted by {sortField}.
slots:
searchString: query.searchString
sortField: query.sortField
- text: List the contacts of user {onBehalfOf}.
slots:
onBehalfOf: query.onBehalfOf
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/contacts'].post
update:
x-apievangelist-phrasing:
intent: Add a new contact
effect: write
questions:
- How do I add someone's email to my address book?
- Is a name required when creating a contact, or just an email?
instructions:
- text: Add contact {name} with email {email}.
slots:
name: requestBody.name
email: requestBody.email
- text: Create a contact for {email}.
slots:
email: requestBody.email
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/contacts/{Id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a contact
effect: destructive
questions:
- How do I remove someone from my address book?
- Can I delete a contact by its ID?
instructions:
- text: Delete contact {Id}.
slots:
Id: path.Id
- text: Remove the address book entry {Id}.
slots:
Id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/contacts/{Id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a contact's name or email
effect: write
questions:
- How do I fix the email address on an existing contact?
- Can I rename a contact without changing the email?
instructions:
- text: Change the email of contact {Id} to {email}.
slots:
Id: path.Id
email: requestBody.email
- text: Rename contact {Id} to {name}.
slots:
Id: path.Id
name: requestBody.name
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.