Generated by API Evangelist
Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Service Management Public REST Customer API
version: 1.0.0
extends: openapi/jira-customer-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: 2
- target: $.paths['/rest/servicedeskapi/customer'].post
update:
x-apievangelist-phrasing:
intent: Create a service desk customer
effect: write
questions:
- How do I add a new customer to Jira Service Management by email?
- Can I get a 409 Conflict instead of success when the customer already exists?
- Does a customer's display name have to be unique?
instructions:
- text: Create customer {displayName} with email {email}.
slots:
displayName: requestBody.displayName
email: requestBody.email
- text: Add customer {email} named {displayName}, returning a conflict if they exist ({strictConflictStatusCode}).
slots:
email: requestBody.email
displayName: requestBody.displayName
strictConflictStatusCode: query.strictConflictStatusCode
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/servicedeskapi/customer/user/{accountId}/revoke-portal-only-access'].put
update:
x-apievangelist-phrasing:
intent: Revoke a user's portal-only access
effect: destructive
questions:
- How do I stop a portal-only customer from logging into the help center?
- What can a user no longer do after their portal-only access is revoked?
instructions:
- text: Revoke portal-only access for user {accountId}.
slots:
accountId: path.accountId
- text: Block portal-only account {accountId} from submitting or viewing portal requests.
slots:
accountId: path.accountId
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.