# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Clerk Com Invitations API version: 1.0.0 extends: openapi/clerk-com-invitations-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['/invitations'].get update: x-apievangelist-phrasing: intent: List application invitations effect: read questions: - How do I see every invitation I've sent to join my application? - Can I list only the invitations that have been accepted? - Which app invitations are still pending? instructions: - text: List all invitations to my application. - text: List application invitations with status {status}. slots: status: query.status - text: Find application invitations matching {query}. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/invitations'].post update: x-apievangelist-phrasing: intent: Invite someone to sign up effect: write questions: - How do I invite a new user to sign up to my application by email? - Can I set how many days an application invitation stays valid? - What happens if an invitation already exists for that email? instructions: - text: Invite {email_address} to sign up to my application. slots: email_address: requestBody.email_address - text: Send an app sign-up invitation to {email_address} that redirects to {redirect_url}. slots: email_address: requestBody.email_address redirect_url: requestBody.redirect_url - text: Invite {email_address} with an invitation that expires in {expires_in_days} days. slots: email_address: requestBody.email_address expires_in_days: requestBody.expires_in_days method: generated generated: '2026-09-26' - target: $.paths['/invitations/bulk'].post update: x-apievangelist-phrasing: intent: Invite many people to sign up at once effect: write questions: - How do I send sign-up invitations to a whole list of email addresses at once? - Can I create many application invitations without emailing them? instructions: - text: Create application sign-up invitations in bulk for this list of emails. - text: Bulk-invite these addresses to my app and send the invitation emails. method: generated generated: '2026-09-26' - target: $.paths['/invitations/{invitation_id}/revoke'].post update: x-apievangelist-phrasing: intent: Revoke an application invitation effect: destructive questions: - How do I cancel an application invitation I sent by mistake? - Does revoking an invitation stop that person from signing up another way? instructions: - text: Revoke application invitation {invitation_id}. slots: invitation_id: path.invitation_id - text: Cancel the sign-up invitation {invitation_id} so its link stops working. slots: invitation_id: path.invitation_id method: generated generated: '2026-09-26' - target: $.paths['/v1/organizations/{organization_id}/invitations'].get update: x-apievangelist-phrasing: intent: List an organization's invitations effect: read questions: - How do I see all invitations sent to join a particular organization? - Can I filter an organization's invitations by status? instructions: - text: List the invitations for organization {organization_id}. slots: organization_id: path.organization_id - text: Show invitations to organization {organization_id} with status {status}. slots: organization_id: path.organization_id status: query.status method: generated generated: '2026-09-26' - target: $.paths['/v1/organizations/{organization_id}/invitations'].post update: x-apievangelist-phrasing: intent: Invite someone to an organization effect: write questions: - How does an organization admin invite a colleague to join their organization? - Can I choose the role a person gets when invited to an organization? instructions: - text: Invite {email_address} to organization {organization_id} as {role}. slots: email_address: requestBody.email_address organization_id: path.organization_id role: requestBody.role - text: Send an organization invite for {organization_id} to {email_address} with role {role}. slots: organization_id: path.organization_id email_address: requestBody.email_address role: requestBody.role method: generated generated: '2026-09-26' - target: $.paths['/v1/organizations/{organization_id}/invitations/bulk'].post update: x-apievangelist-phrasing: intent: Invite many people to an organization effect: write questions: - How do I invite a whole team to an organization in one request? - Can organization invitations be created in bulk with a role each? instructions: - text: Bulk-invite {email_address} to organization {organization_id} with role {role}. slots: email_address: requestBody.email_address organization_id: path.organization_id role: requestBody.role - text: Create several invitations at once to organization {organization_id} for {email_address} as {role}. slots: organization_id: path.organization_id email_address: requestBody.email_address role: requestBody.role method: generated generated: '2026-09-26' - target: $.paths['/v1/organizations/{organization_id}/invitations/pending'].get update: x-apievangelist-phrasing: intent: List pending organization invitations (legacy) effect: read questions: - Which invitations to an organization have not been accepted yet, using the older pending endpoint? - Is the dedicated pending-invitations endpoint deprecated? instructions: - text: List the pending invitations of organization {organization_id} using the legacy pending endpoint. slots: organization_id: path.organization_id - text: Show unaccepted invites for organization {organization_id} from the deprecated pending list. slots: organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/v1/organizations/{organization_id}/invitations/{invitation_id}/revoke'].post update: x-apievangelist-phrasing: intent: Revoke a pending organization invitation effect: destructive questions: - How do I withdraw an invitation to join an organization before it is accepted? - Can an organization admin cancel a pending invite? instructions: - text: Revoke invitation {invitation_id} to organization {organization_id}. slots: invitation_id: path.invitation_id organization_id: path.organization_id - text: Withdraw the pending organization invite {invitation_id} in {organization_id}. slots: invitation_id: path.invitation_id organization_id: path.organization_id method: generated generated: '2026-09-26'