Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for User Management Record Type Permission API
9 actions
9 updates
phrasing
extends
openapi/conga-record-type-permission-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/api/user-management/v1/recordtype-permissions'].put
$.paths['/api/user-management/v1/recordtype-permissions'].post
$.paths['/api/user-management/v1/recordtype-permissions/bulk'].post
$.paths['/api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName}'].get
$.paths['/api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName}'].delete
$.paths['/api/user-management/v1/recordtype-permissions/{recordTypePermissionId}'].delete
$.paths['/api/user-management/v1/recordtype-permissions/{recordtypePermissionId}'].get
$.paths['/api/user-management/v1/recordtype-permissions/{recordtypePermissionId}'].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 Record Type Permission API
version: 1.0.0
extends: openapi/conga-record-type-permission-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: 8
- target: $.paths['/api/user-management/v1/recordtype-permissions'].put
update:
x-apievangelist-phrasing:
intent: Update record type access by group and object
effect: write
questions:
- How do I change which record types a permission group can use on an object, without knowing the permission ID?
- Can I update record type access by naming the permission group and object?
instructions:
- text: Update record type access on {ObjectName} for permission group {PermissionGroupName} to {RecordTypeAccess}.
slots:
ObjectName: requestBody.ObjectName
PermissionGroupName: requestBody.PermissionGroupName
RecordTypeAccess: requestBody.RecordTypeAccess
- text: Change permission group {PermissionGroupName}'s record type permission on object {ObjectName}.
slots:
PermissionGroupName: requestBody.PermissionGroupName
ObjectName: requestBody.ObjectName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions'].post
update:
x-apievangelist-phrasing:
intent: Grant a record type permission
effect: write
questions:
- How do I give a permission group access to specific record types on an object?
- What ID do I get back after setting a new record type permission?
instructions:
- text: Grant permission group {PermissionGroupName} record type access {RecordTypeAccess} on {ObjectName}.
slots:
PermissionGroupName: requestBody.PermissionGroupName
RecordTypeAccess: requestBody.RecordTypeAccess
ObjectName: requestBody.ObjectName
- text: Set a new record type permission for object {ObjectName} and group {PermissionGroupName}.
slots:
ObjectName: requestBody.ObjectName
PermissionGroupName: requestBody.PermissionGroupName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/bulk'].post
update:
x-apievangelist-phrasing:
intent: Grant many record type permissions at once
effect: write
questions:
- Can I set record type permissions for several groups and objects in one request?
- Is there a bulk way to load record type permissions?
instructions:
- text: Bulk-set these record type permissions.
- text: Create several record type permissions in one batch.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName}'].get
update:
x-apievangelist-phrasing:
intent: Get record type access by group and object
effect: read
questions:
- Which record types can a given permission group access on an object?
- Can I look up a record type permission by group name and object instead of ID?
instructions:
- text: Show record type access for permission group {permissionGroupName} on {objectName}.
slots:
permissionGroupName: path.permissionGroupName
objectName: path.objectName
- text: Get the record type permission of group {permissionGroupName} for object {objectName}.
slots:
permissionGroupName: path.permissionGroupName
objectName: path.objectName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/{permissionGroupName}/{objectName}'].delete
update:
x-apievangelist-phrasing:
intent: Revoke record type access by group and object
effect: destructive
questions:
- How do I remove a permission group's record type access on an object?
- Can I revoke a record type permission using the group name and object?
instructions:
- text: Revoke record type access of group {permissionGroupName} on {objectName}.
slots:
permissionGroupName: path.permissionGroupName
objectName: path.objectName
- text: Delete permission group {permissionGroupName}'s record type permission for object {objectName}.
slots:
permissionGroupName: path.permissionGroupName
objectName: path.objectName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/{recordTypePermissionId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a record type permission by ID
effect: destructive
questions:
- How do I delete a record type permission when I have its ID?
- What's the way to remove one record type permission record by its identifier?
instructions:
- text: Delete record type permission {recordTypePermissionId}.
slots:
recordTypePermissionId: path.recordTypePermissionId
- text: Remove the record type permission with ID {recordTypePermissionId}.
slots:
recordTypePermissionId: path.recordTypePermissionId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/{recordtypePermissionId}'].get
update:
x-apievangelist-phrasing:
intent: Get a record type permission by ID
effect: read
questions:
- How do I fetch a record type permission's details from its ID?
- What does a specific record type permission record contain?
instructions:
- text: Get record type permission {recordtypePermissionId}.
slots:
recordtypePermissionId: path.recordtypePermissionId
- text: Show details of the record type permission with ID {recordtypePermissionId}.
slots:
recordtypePermissionId: path.recordtypePermissionId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/recordtype-permissions/{recordtypePermissionId}'].put
update:
x-apievangelist-phrasing:
intent: Update a record type permission by ID
effect: write
questions:
- Can I edit a record type permission using its permission ID?
- Which fields can I change on an existing record type permission by ID?
instructions:
- text: Update record type permission {recordtypePermissionId} to access {RecordTypeAccess}.
slots:
recordtypePermissionId: path.recordtypePermissionId
RecordTypeAccess: requestBody.RecordTypeAccess
- text: Edit record type permission ID {recordtypePermissionId}.
slots:
recordtypePermissionId: path.recordtypePermissionId
method: generated
generated: '2026-10-01'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/conga-record-type-permission-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
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.
A second provider on the same verified email joins the account you already have.