Conga Role API
The Role API from Conga — 6 operation(s) for role.
Operations 11
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/v1/cs-packages/{packageId}/groups
Add an ad hoc signer group to a transaction · Adds a new ad hoc group to a transaction
#
Ask an LLM
“How do I create a group where any one member can sign for everyone?”
“Can I add an ad hoc group of signers to an existing transaction?”
Tell an agent
Add an ad hoc signing group to package {packageId}.
Create an ad hoc group in transaction {packageId} where one member signs for all.
DELETE
/v1/cs-packages/{packageId}/groups/{roleId}
Delete an ad hoc group · Deletes a specified ad hoc group
#
Ask an LLM
“What happens to member roles when I delete an ad hoc group?”
“How do I remove an ad hoc signing group from a transaction?”
Tell an agent destructive · confirm first
Delete ad hoc group {roleId} from package {packageId}.
Remove the ad hoc group {roleId} and its members from transaction {packageId}.
PUT
/v1/cs-packages/{packageId}/groups/{roleId}
Update an ad hoc group's members · Updates a transaction's existing ad hoc group
#
Ask an LLM
“How do I change the members of an ad hoc group in a transaction?”
“Can I add someone to an existing ad hoc signing group?”
Tell an agent
Update ad hoc group {roleId} in package {packageId}.
Change the members of ad hoc group {roleId} in transaction {packageId}.
Ask an LLM
“How do I add another signer to an existing package?”
“Can I require attachments from a new recipient when adding them?”
Tell an agent
Add a role named {name} to package {packageId}.
Add signers {signers} as a new role on package {packageId}.
Ask an LLM
“Who are the signers and roles on a package?”
“How do I list every role in a transaction?”
Tell an agent
List all roles in package {packageId}.
Show me the recipients of package {packageId}.
Ask an LLM
“Can I change the signing order of roles in a package?”
“How do I move a signer earlier in the signing sequence?”
Tell an agent
Reorder the roles in package {packageId}.
Change the signing order of package {packageId}.
Ask an LLM
“How do I remove a signer from a package?”
“Can I delete a recipient role I no longer need?”
Tell an agent destructive · confirm first
Delete role {roleId} from package {packageId}.
Remove signer {roleId} from package {packageId}.
Ask an LLM
“How do I look up a single signer role on a package?”
“What details are stored for one recipient role?”
Tell an agent
Get role {roleId} in package {packageId}.
Show the details of recipient {roleId} on package {packageId}.
Ask an LLM
“How do I change a signer's details on a package role?”
“Can I allow a recipient to reassign their signing role?”
Tell an agent
Update role {roleId} in package {packageId}.
Set reassign to {reassign} on role {roleId} of package {packageId}.
POST
/v1/cs-packages/{packageId}/roles/{roleId}/unlock
Unlock a locked signer role · Unlock a role
#
Ask an LLM
“How do I unlock a signer who got locked out?”
“Can a locked role be unlocked so they can sign again?”
Tell an agent
Unlock role {roleId} in package {packageId}.
Unlock the locked-out signer {roleId} on package {packageId}.
Ask an LLM
“Which user-management roles are defined in my Conga platform tenant?”
“Can I exclude deleted roles when listing platform roles by criteria?”
Tell an agent
List the tenant's user-management roles matching {criteria}.
Show platform roles sorted by {sortField} in {sortDirection} order, {pageSize} per page.
Documentation
Authentication
https://artifacts.apis.io/conga/authentication/conga-authentication.yml
RateLimits
https://artifacts.apis.io/conga/rate-limits/conga-rate-limits.yml
Specifications
Other Resources
DataModel
https://artifacts.apis.io/conga/data-model/conga-data-model.yml
OAuthScopes
https://artifacts.apis.io/conga/scopes/conga-scopes.yml
Conventions
https://artifacts.apis.io/conga/conventions/conga-conventions.yml
ErrorCatalog
https://artifacts.apis.io/conga/errors/conga-problem-types.yml
Lifecycle
https://artifacts.apis.io/conga/lifecycle/conga-lifecycle.yml
Conformance
https://artifacts.apis.io/conga/conformance/conga-conformance.yml
Sandbox
https://artifacts.apis.io/conga/sandbox/conga-sandbox.yml
Webhooks
https://artifacts.apis.io/conga/asyncapi/conga-webhooks.yml