Infobip · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Infobip OpenAPI Specification Platform API
195 actions
195 updates
phrasing
extends
openapi/infobip-platform-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Infobip's API. It is a proposal applied on top of the contract, not a document Infobip publishes.
What the actions change
x-apievangelist-phrasing
Targets 195 · first 16 shown; the file carries all of them
$.info
$.paths['/2fa/2/applications'].get
$.paths['/2fa/2/applications'].post
$.paths['/2fa/2/applications/{appId}'].get
$.paths['/2fa/2/applications/{appId}'].put
$.paths['/2fa/2/applications/{appId}/messages'].get
$.paths['/2fa/2/applications/{appId}/messages'].post
$.paths['/2fa/2/applications/{appId}/messages/{msgId}'].get
$.paths['/2fa/2/applications/{appId}/messages/{msgId}'].put
$.paths['/2fa/2/applications/{appId}/email/messages'].post
$.paths['/2fa/2/applications/{appId}/email/messages/{msgId}'].put
$.paths['/2fa/2/pin'].post
$.paths['/2fa/2/pin/{pinId}/resend'].post
$.paths['/2fa/2/pin/voice'].post
$.paths['/2fa/2/pin/{pinId}/resend/voice'].post
$.paths['/2fa/2/pin/email'].post
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 Infobip OpenAPI Specification Platform API
version: 1.0.0
extends: openapi/infobip-platform-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: 194
- target: $.paths['/2fa/2/applications'].get
update:
x-apievangelist-phrasing:
intent: List my 2FA applications
effect: read
questions:
- Which 2FA applications have I set up in Infobip?
- Where can I see every two-factor authentication app container on my account?
instructions:
- text: List all my 2FA applications.
- text: Show me every two-factor application I've configured so far.
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications'].post
update:
x-apievangelist-phrasing:
intent: Create a 2FA application
effect: write
questions:
- What do I need to set up a new two-factor authentication application?
- Can a new 2FA application be created in a disabled state?
instructions:
- text: Create a new 2FA application named {name}.
slots:
name: requestBody.name
- text: Set up a 2FA app called {name} with configuration {configuration}.
slots:
name: requestBody.name
configuration: requestBody.configuration
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}'].get
update:
x-apievangelist-phrasing:
intent: Get a 2FA application's configuration
effect: read
questions:
- How is a specific 2FA application of mine configured?
- Can I look up the PIN attempt and TTL settings of one 2FA app?
instructions:
- text: Show the configuration of 2FA application {appId}.
slots:
appId: path.appId
- text: Fetch the details of two-factor app {appId}.
slots:
appId: path.appId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}'].put
update:
x-apievangelist-phrasing:
intent: Update a 2FA application
effect: write
questions:
- Can I change the settings of a 2FA application I already created?
- Is it possible to disable an existing two-factor application?
instructions:
- text: Rename 2FA application {appId} to {name}.
slots:
appId: path.appId
name: requestBody.name
- text: Disable 2FA application {appId} by setting enabled to {enabled}, keeping the name {name}.
slots:
appId: path.appId
enabled: requestBody.enabled
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/messages'].get
update:
x-apievangelist-phrasing:
intent: List message templates in a 2FA application
effect: read
questions:
- Which PIN message templates exist inside one of my 2FA applications?
- Where do I see all the OTP text templates under a 2FA app?
instructions:
- text: List the message templates in 2FA application {appId}.
slots:
appId: path.appId
- text: Show every PIN template configured for 2FA app {appId}.
slots:
appId: path.appId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/messages'].post
update:
x-apievangelist-phrasing:
intent: Create a 2FA SMS or voice PIN template
effect: write
questions:
- How do I create an SMS or voice template for sending one-time PINs?
- Can I choose the PIN length and whether it's numeric or alphanumeric in a template?
- Is there a way to set the voice and speech rate for a spoken OTP template?
instructions:
- text: Create a 2FA message template in app {appId} with text {messageText} and PIN type {pinType}.
slots:
appId: path.appId
messageText: requestBody.messageText
pinType: requestBody.pinType
- text: Add a {pinLength}-digit {pinType} PIN template to 2FA app {appId} saying {messageText}.
slots:
pinLength: requestBody.pinLength
pinType: requestBody.pinType
appId: path.appId
messageText: requestBody.messageText
- text: Create a voice OTP template in app {appId} reading {messageText} with PIN type {pinType} using voice {voiceName}.
slots:
appId: path.appId
messageText: requestBody.messageText
pinType: requestBody.pinType
voiceName: requestBody.voiceName
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/messages/{msgId}'].get
update:
x-apievangelist-phrasing:
intent: Get a 2FA message template
effect: read
questions:
- What does one particular 2FA PIN template contain?
- Can I check the sender ID and PIN length set on a single OTP template?
instructions:
- text: Show 2FA message template {msgId} from application {appId}.
slots:
msgId: path.msgId
appId: path.appId
- text: Fetch the settings of PIN template {msgId} in 2FA app {appId}.
slots:
msgId: path.msgId
appId: path.appId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/messages/{msgId}'].put
update:
x-apievangelist-phrasing:
intent: Update a 2FA SMS or voice PIN template
effect: write
questions:
- Can I edit the text of an SMS or voice OTP template I already made?
- Is it possible to change the sender ID on an existing 2FA SMS template?
instructions:
- text: Change the text of 2FA template {msgId} in app {appId} to {messageText}.
slots:
msgId: path.msgId
appId: path.appId
messageText: requestBody.messageText
- text: Set the sender ID of SMS PIN template {msgId} in app {appId} to {senderId}.
slots:
msgId: path.msgId
appId: path.appId
senderId: requestBody.senderId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/email/messages'].post
update:
x-apievangelist-phrasing:
intent: Create a 2FA email PIN template
effect: write
questions:
- Can one-time PINs be delivered by email using one of my email templates?
- What's needed to set up an email OTP template with a landing page?
instructions:
- text: Create an email PIN template in 2FA app {appId} using email template {emailTemplateId}.
slots:
appId: path.appId
emailTemplateId: requestBody.emailTemplateId
- text: Add a 2FA email template to app {appId} with email template {emailTemplateId} sent from {from}.
slots:
appId: path.appId
emailTemplateId: requestBody.emailTemplateId
from: requestBody.from
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/email/messages/{msgId}'].put
update:
x-apievangelist-phrasing:
intent: Update a 2FA email PIN template
effect: write
questions:
- Can I change which email template an existing 2FA email OTP template uses?
- Is the sender address editable on a 2FA email template I already created?
instructions:
- text: Point 2FA email template {msgId} in app {appId} at email template {emailTemplateId}.
slots:
msgId: path.msgId
appId: path.appId
emailTemplateId: requestBody.emailTemplateId
- text: Change the from address of 2FA email template {msgId} in app {appId} to {from}.
slots:
msgId: path.msgId
appId: path.appId
from: requestBody.from
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin'].post
update:
x-apievangelist-phrasing:
intent: Send a one-time PIN by SMS
effect: write
questions:
- How do I text a verification code to a user's phone?
- Can I track delivery of an OTP I send by SMS?
instructions:
- text: Send an SMS PIN to {to} using 2FA app {applicationId} and template {messageId}.
slots:
to: requestBody.to
applicationId: requestBody.applicationId
messageId: requestBody.messageId
- text: Text a verification code to {to} from app {applicationId} with template {messageId} and sender {from}.
slots:
to: requestBody.to
applicationId: requestBody.applicationId
messageId: requestBody.messageId
from: requestBody.from
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/{pinId}/resend'].post
update:
x-apievangelist-phrasing:
intent: Resend the same PIN by SMS
effect: write
questions:
- My user didn't get their SMS code — can I resend the same one?
- Is it possible to text a previously sent PIN again without generating a new one?
instructions:
- text: Resend PIN {pinId} by SMS.
slots:
pinId: path.pinId
- text: Text the same verification code for PIN {pinId} again.
slots:
pinId: path.pinId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/voice'].post
update:
x-apievangelist-phrasing:
intent: Send a one-time PIN by voice call
effect: write
questions:
- Can a verification code be read out to a user over a phone call?
- What do I need to deliver an OTP as a voice message?
instructions:
- text: Call {to} with a voice PIN using 2FA app {applicationId} and template {messageId}.
slots:
to: requestBody.to
applicationId: requestBody.applicationId
messageId: requestBody.messageId
- text: Deliver a spoken verification code to {to} from app {applicationId}, template {messageId}.
slots:
to: requestBody.to
applicationId: requestBody.applicationId
messageId: requestBody.messageId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/{pinId}/resend/voice'].post
update:
x-apievangelist-phrasing:
intent: Resend the same PIN by voice call
effect: write
questions:
- Can I repeat a voice OTP call with the same code the user already got?
- The user missed the verification call — is there a way to call again with the same PIN?
instructions:
- text: Resend PIN {pinId} as a voice call.
slots:
pinId: path.pinId
- text: Call the user again with the same code for PIN {pinId}.
slots:
pinId: path.pinId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/email'].post
update:
x-apievangelist-phrasing:
intent: Send a one-time PIN by email
effect: write
questions:
- How can I email a verification code to a user?
- Can I fill landing page placeholders when emailing an OTP?
instructions:
- text: Email a PIN to {to} using 2FA app {applicationId} and email template {messageId}.
slots:
to: requestBody.to
applicationId: requestBody.applicationId
messageId: requestBody.messageId
- text: Send a verification code by email to {to} from {from} via app {applicationId}, template {messageId}.
slots:
to: requestBody.to
from: requestBody.from
applicationId: requestBody.applicationId
messageId: requestBody.messageId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/{pinId}/resend/email'].post
update:
x-apievangelist-phrasing:
intent: Resend the same PIN by email
effect: write
questions:
- Can I re-send an emailed verification code that the user can't find?
- Is there a way to email the same OTP again rather than issuing a new one?
instructions:
- text: Resend PIN {pinId} by email.
slots:
pinId: path.pinId
- text: Email the same verification code for PIN {pinId} again.
slots:
pinId: path.pinId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/pin/{pinId}/verify'].post
update:
x-apievangelist-phrasing:
intent: Verify a PIN a user entered
effect: write
questions:
- How do I check whether the code a user typed in is correct?
- What happens when someone submits a wrong OTP too many times?
instructions:
- text: Verify PIN {pinId} with the code {pin}.
slots:
pinId: path.pinId
pin: requestBody.pin
- text: Check whether {pin} is the right code for PIN {pinId}.
slots:
pin: requestBody.pin
pinId: path.pinId
method: generated
generated: '2026-09-26'
- target: $.paths['/2fa/2/applications/{appId}/verifications'].get
update:
x-apievangelist-phrasing:
intent: Check if a number is verified in a 2FA app
effect: read
questions:
- Has this phone number already been verified in my 2FA application?
- Can I filter verification status to only numbers that were sent a PIN but never verified?
instructions:
- text: Check the verification status of {msisdn} in 2FA app {appId}.
slots:
msisdn: query.msisdn
appId: path.appId
- text: Show whether {msisdn} is verified for 2FA application {appId}, filtering verified={verified}.
slots:
msisdn: query.msisdn
appId: path.appId
verified: query.verified
method: generated
generated: '2026-09-26'
- target: $.paths['/account/1/balance'].get
update:
x-apievangelist-phrasing:
intent: Get my current account balance
effect: read
questions:
- What's my current Infobip account balance?
- Which currency is my balance shown in?
instructions:
- text: Show my current account balance.
- text: Tell me how much credit is left on my account right now.
method: generated
generated: '2026-09-26'
- target: $.paths['/account/1/free-messages'].get
update:
x-apievangelist-phrasing:
intent: Get my remaining free messages
effect: read
questions:
- How many free messages do I have left?
- Is there any free message allowance remaining on my account?
instructions:
- text: Show my remaining free message count.
- text: Check how many free messages are still available.
method: generated
generated: '2026-09-26'
- target: $.paths['/account/1/total-balance'].get
update:
x-apievangelist-phrasing:
intent: Get balance with credit limits and free messages
effect: read
questions:
- Can I see my monthly balance and credit limits together with my free messages?
- What is my total credit limit and how much free messaging is left per service type?
instructions:
- text: Show my full balance summary including credit limits and free messages per service.
- text: Get my monthly balance, total credit limit and currency details.
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts'].get
update:
x-apievangelist-phrasing:
intent: List sub-accounts
effect: read
questions:
- Which sub-accounts sit under my main account?
- Can I list only the enabled sub-accounts, or search them by name?
instructions:
- text: List my sub-accounts named {name}.
slots:
name: query.name
- text: Show up to {limit} sub-accounts where enabled is {enabled}.
slots:
limit: query.limit
enabled: query.enabled
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts/{accountKey}'].put
update:
x-apievangelist-phrasing:
intent: Update a sub-account
effect: write
questions:
- Can I rename or disable one of my sub-accounts?
- Is it possible to edit the main account itself, or only sub-accounts?
instructions:
- text: Rename sub-account {accountKey} to {name}.
slots:
accountKey: path.accountKey
name: requestBody.name
- text: Set enabled to {enabled} on sub-account {accountKey}.
slots:
enabled: requestBody.enabled
accountKey: path.accountKey
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts/{accountKey}/api-keys'].get
update:
x-apievangelist-phrasing:
intent: List an account's API keys (legacy endpoint)
effect: read
questions:
- Using the older per-account settings endpoint, which API keys belong to a given account?
- Can the legacy v1 key listing filter by public API key value?
instructions:
- text: With the legacy v1 endpoint, list API keys for account {accountKey}.
slots:
accountKey: path.accountKey
- text: Find the key named {name} on account {accountKey} using the old v1 API key listing.
slots:
name: query.name
accountKey: path.accountKey
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts/{accountKey}/api-keys'].post
update:
x-apievangelist-phrasing:
intent: Create an account API key (legacy endpoint)
effect: write
questions:
- How do I create an API key under a specific account using the older v1 settings API?
- Can a legacy v1 API key be restricted to certain IP addresses?
instructions:
- text: Using the legacy v1 endpoint, create an API key {name} for account {accountKey}.
slots:
name: requestBody.name
accountKey: path.accountKey
- text: Create a v1 API key {name} on account {accountKey} allowed only from {allowedIPs}.
slots:
name: requestBody.name
accountKey: path.accountKey
allowedIPs: requestBody.allowedIPs
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts/{accountKey}/api-keys/{key}'].get
update:
x-apievangelist-phrasing:
intent: Get an account API key (legacy endpoint)
effect: read
questions:
- With the old v1 settings API, how do I look up one key under an account?
- Can I use the underscore shortcut for my own account when fetching a legacy key?
instructions:
- text: Using the legacy v1 endpoint, show API key {key} on account {accountKey}.
slots:
key: path.key
accountKey: path.accountKey
- text: Fetch v1 key {key} from my own account using accountKey {accountKey}.
slots:
key: path.key
accountKey: path.accountKey
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/1/accounts/{accountKey}/api-keys/{key}'].put
update:
x-apievangelist-phrasing:
intent: Update an account API key (legacy endpoint)
effect: write
questions:
- Can I disable a key through the older v1 account-scoped key endpoint?
- Is the validity window editable on a legacy v1 API key?
instructions:
- text: Using the legacy v1 endpoint, disable key {key} on account {accountKey} by setting enabled to {enabled}.
slots:
key: path.key
accountKey: path.accountKey
enabled: requestBody.enabled
- text: Set v1 key {key} on account {accountKey} to expire at {validTo}.
slots:
key: path.key
accountKey: path.accountKey
validTo: requestBody.validTo
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/2/api-keys'].get
update:
x-apievangelist-phrasing:
intent: Search API keys
effect: read
questions:
- Which API keys exist across my accounts, and can I sort them?
- Who is allowed to list API keys — do I need a special role?
instructions:
- text: List API keys named {name}.
slots:
name: query.name
- text: Show API keys for account {accountId}, page {page}, ordered by {orderBy}.
slots:
accountId: query.accountId
page: query.page
orderBy: query.orderBy
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/2/api-keys'].post
update:
x-apievangelist-phrasing:
intent: Create an API key
effect: write
questions:
- How do I generate a new API key with specific scopes?
- Can I limit a new API key to a validity period and a set of IPs?
instructions:
- text: Create an API key called {name}.
slots:
name: requestBody.name
- text: Create API key {name} for account {accountId} with scopes {scopeGuids}.
slots:
name: requestBody.name
accountId: requestBody.accountId
scopeGuids: requestBody.scopeGuids
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/2/api-keys/{apiKeyId}'].get
update:
x-apievangelist-phrasing:
intent: Get an API key
effect: read
questions:
- What scopes and IP restrictions does one of my API keys have?
- Can I look up a single key by its ID?
instructions:
- text: Show API key {apiKeyId}.
slots:
apiKeyId: path.apiKeyId
- text: Fetch the scopes and allowed IPs of key {apiKeyId}.
slots:
apiKeyId: path.apiKeyId
method: generated
generated: '2026-09-26'
- target: $.paths['/settings/2/api-keys/{apiKeyId}'].put
update:
x-apievangelist-phrasing:
intent: Update an API key
effect: write
questions:
- Can I change the scopes of an API key that's already in use?
- Is it possible to switch off an API key without deleting it?
instructions:
- text: Disable API key {apiKeyId} by setting enabled to {enabled}.
slots:
apiKeyId: path.apiKeyId
enabled: requestBody.enabled
- text: Replace the scopes on key {apiKeyId} with {scopeGuids}.
slots:
apiKeyId: path.apiKeyId
scopeGuids: requestBody.scopeGuids
method: generated
generated: '2026-09-26'
- target: $.paths['/auth/1/session'].post
update:
x-apievangelist-phrasing:
intent: Log in and create a session token
effect: write
questions:
- How do I log in with a username and password to get a session token?
- How long does a session token last before it expires?
instructions:
- text: Log in as {username} with password {password} and get a session token.
slots:
username: requestBody.username
password: requestBody.password
- text: Create a session for {username} using {password} that isn't bound to my IP ({unsafe}).
slots:
username: requestBody.username
password: requestBody.password
unsafe: requestBody.unsafe
method: generated
generated: '2026-09-26'
- target: $.paths['/auth/1/session'].delete
update:
x-apievangelist-phrasing:
intent: Log out and destroy the session token
effect: destructive
questions:
- How do I log out and invalidate my current session token?
- Do I have to end my session before I can create a fresh token?
instructions:
- text: Log me out and destroy my session token.
- text: End the current session so I can start a new one.
method: generated
generated: '2026-09-26'
- target: $.paths['/auth/1/oauth2/token'].post
update:
x-apievangelist-phrasing:
intent: Get an OAuth2 access token
effect: write
questions:
- Can I authenticate API calls with OAuth2 client credentials?
- Which grant type do I pass to exchange a client ID and secret for an access token?
instructions:
- text: Get an OAuth2 access token for client {client_id} with secret {client_secret} and grant type {grant_type}.
slots:
client_id: requestBody.client_id
client_secret: requestBody.client_secret
grant_type: requestBody.grant_type
- text: Exchange authorization code {code} for a token as client {client_id}, secret {client_secret}, grant {grant_type}.
slots:
code: requestBody.code
client_id: requestBody.client_id
client_secret: requestBody.client_secret
grant_type: requestBody.grant_type
method: generated
generated: '2026-09-26'
- target: $.paths['/audit/1/logs/export'].get
update:
x-apievangelist-phrasing:
intent: Export audit logs to a file
effect: read
questions:
- Can I download a file of what users did in the web interface?
- Is there a way to export audit activity for a date range?
instructions:
- text: Export audit logs from {from} to {to}.
slots:
from: query.from
to: query.to
- text: Download an export of audit activity by user {userKey}.
slots:
userKey: query.userKey
method: generated
generated: '2026-09-26'
- target: $.paths['/audit/1/logs'].get
update:
x-apievangelist-phrasing:
intent: Search audit logs
effect: read
questions:
- Who changed settings in our web portal recently?
- Can I search user activity by IP address or action type?
instructions:
- text: Search audit logs for actions from IP {ipAddress}.
slots:
ipAddress: query.ipAddress
- text: Show audit entries with action {action} between {from} and {to}.
slots:
action: query.action
from: query.from
to: query.to
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/applications'].get
update:
x-apievangelist-phrasing:
intent: List provisioning applications
effect: read
questions:
- Which applications have I defined for grouping my traffic and resources?
- Can I page through my provisioning applications?
instructions:
- text: List my applications.
- text: Show page {page} of my applications, {size} per page.
slots:
page: query.page
size: query.size
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/applications'].post
update:
x-apievangelist-phrasing:
intent: Create an application
effect: write
questions:
- How do I register a new application ID to tag my traffic?
- Can I give an application a readable name as well as an ID?
instructions:
- text: Create an application with ID {applicationId}.
slots:
applicationId: requestBody.applicationId
- text: Create application {applicationId} named {applicationName}.
slots:
applicationId: requestBody.applicationId
applicationName: requestBody.applicationName
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/applications/{applicationId}'].get
update:
x-apievangelist-phrasing:
intent: Get an application
effect: read
questions:
- What name is set on one of my applications?
- Can I look up a single application by its ID?
instructions:
- text: Show application {applicationId}.
slots:
applicationId: path.applicationId
- text: Fetch the details of app ID {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/applications/{applicationId}'].put
update:
x-apievangelist-phrasing:
intent: Rename an application
effect: write
questions:
- Can I change the display name of an existing application?
- Is the application name the only thing I can edit on an application?
instructions:
- text: Rename application {applicationId} to {applicationName}.
slots:
applicationId: path.applicationId
applicationName: requestBody.applicationName
- text: Change the name of app {applicationId} to {applicationName}.
slots:
applicationId: path.applicationId
applicationName: requestBody.applicationName
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/applications/{applicationId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an application
effect: destructive
questions:
- What happens to linked resources when I delete an application?
- Can I remove an application I no longer use?
instructions:
- text: Delete application {applicationId}.
slots:
applicationId: path.applicationId
- text: Remove app {applicationId} and reset its linked resources.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/entities'].get
update:
x-apievangelist-phrasing:
intent: List entities
effect: read
questions:
- Which entities have I set up to segment my traffic?
- Can I page through all my entities?
instructions:
- text: List my entities.
- text: Show page {page} of entities, {size} at a time.
slots:
page: query.page
size: query.size
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/entities'].post
update:
x-apievangelist-phrasing:
intent: Create an entity
effect: write
questions:
- Do I have to create an entity before sending messages tagged with it?
- Can I give a new entity a friendly name?
instructions:
- text: Create an entity with ID {entityId}.
slots:
entityId: requestBody.entityId
- text: Create entity {entityId} named {entityName}.
slots:
entityId: requestBody.entityId
entityName: requestBody.entityName
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/entities/{entityId}'].get
update:
x-apievangelist-phrasing:
intent: Get an entity
effect: read
questions:
- What name is stored on a particular entity?
- Can I fetch one entity by its entity ID?
instructions:
- text: Show entity {entityId}.
slots:
entityId: path.entityId
- text: Fetch the details of entity ID {entityId}.
slots:
entityId: path.entityId
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/entities/{entityId}'].put
update:
x-apievangelist-phrasing:
intent: Rename an entity
effect: write
questions:
- Can I change the name of an entity after creating it?
- Is renaming the only change allowed on an entity?
instructions:
- text: Rename entity {entityId} to {entityName}.
slots:
entityId: path.entityId
entityName: requestBody.entityName
- text: Change entity {entityId}'s display name to {entityName}.
slots:
entityId: path.entityId
entityName: requestBody.entityName
method: generated
generated: '2026-09-26'
- target: $.paths['/provisioning/1/entities/{entityId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an entity
effect: destructive
questions:
- What happens to resources linked to an entity when it's deleted?
- Can I remove an entity I no longer need?
instructions:
- text: Delete entity {entityId}.
slots:
entityId: path.entityId
- text: Remove entity {entityId} and reset the resources linked to it.
slots:
entityId: path.entityId
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/overlays/infobip-platform-api-phrasing-overlay.yaml