Skip to main content
New to Corsair? See API access, authentication, and error handling.

Accounts

addTag

accounts.addTag Add a tag to an account Risk: write
Input Output

create

accounts.create Create an account Risk: write
Input
Output

get

accounts.get Read one account by id Risk: read
Input Output

list

accounts.list List accounts, filtered by reference id, page by page Risk: read
Input Output

redact

accounts.redact Redact an account; the data is permanently removed Risk: destructive · Irreversible
Input Answers the redacted account; redaction is permanent. Output

removeTag

accounts.removeTag Remove a tag from an account Risk: write
Input Output

accounts.search Search accounts with a predicate query Risk: read
Input query is a predicate tree: { attribute, operator, value } leaves combined with and/or/not.
Output

update

accounts.update Update an account’s attributes, status or tags Risk: write
Input
Output

Inquiries

addTag

inquiries.addTag Add a tag to an inquiry Risk: write
Input Output

approve

inquiries.approve Approve an inquiry; the decision is final and runs any approval workflow Risk: destructive · Irreversible
Input Final decision; comment is kept for auditing. Output

create

inquiries.create Create an inquiry from a template Risk: write
Input Pass inquiry-template-id for itmpl_ templates, template-id for legacy tmpl_ flows, or inquiry-template-version-id; fields carries the template field values.
Output

decline

inquiries.decline Decline an inquiry; the decision is final Risk: destructive · Irreversible
Input Final decision; comment is kept for auditing. Output

inquiries.generateOneTimeLink Generate a one-time link for an inquiry; anyone with the link can resume it Risk: write
Input The link is in meta.one-time-link; anyone with it can resume the inquiry. Output

get

inquiries.get Read one inquiry by id Risk: read
Input Output

list

inquiries.list List inquiries filtered by status, account, reference or template Risk: read
Input Output

markForReview

inquiries.markForReview Mark an inquiry for manual review Risk: write
Input Output

redact

inquiries.redact Redact an inquiry; the data is permanently removed Risk: destructive · Irreversible
Input Output

removeTag

inquiries.removeTag Remove a tag from an inquiry Risk: write
Input Output

update

inquiries.update Update inquiry attributes Risk: write
Input
Output

Inquiry Sessions

create

inquirySessions.create Create a session for an inquiry Risk: write
Input Output

expire

inquirySessions.expire Expire one inquiry session Risk: write
Input Output

expireAll

inquirySessions.expireAll Expire every session of the given inquiries Risk: destructive · Irreversible
Input Expires every session of the given inquiries and answers the expired sessions. Output

inquirySessions.generateOneTimeLink Generate a one-time link for an inquiry session Risk: write
Input Output

get

inquirySessions.get Read one inquiry session Risk: read
Input Output

Inquiry Templates

get

inquiryTemplates.get Read one inquiry template Risk: read
Input Output

list

inquiryTemplates.list List the inquiry templates Risk: read
Input Output

listVersions

inquiryTemplates.listVersions List the versions of one inquiry template Risk: read
Input Output

Webhooks

archive

webhooks.archive Archive a webhook; archived webhooks cannot be re-enabled Risk: destructive · Irreversible
Input Output

create

webhooks.create Create a webhook; the answer carries its signing secret Risk: write
Input enabled-events lists Persona event names, e.g. inquiry.approved, inquiry.declined, or * for all. The answer carries the signing secret.
Output

disable

webhooks.disable Disable a webhook; deliveries stop until it is enabled again Risk: write
Input Output

enable

webhooks.enable Enable a webhook Risk: write
Input Output

get

webhooks.get Read one webhook Risk: read
Input Output

list

webhooks.list List the webhooks Risk: read
Input Output

rotateSecret

webhooks.rotateSecret Rotate the webhook signing secret; the old one stops signing once its window ends Risk: destructive · Irreversible
Input The answer carries the new signing secret; store it with keys.set_webhook_signature. expiresInSeconds keeps the old one signing meanwhile. Output

searchEvents

webhooks.searchEvents Search recorded webhook events Risk: read
Input
Output

update

webhooks.update Update a webhook URL, name or subscribed events Risk: write
Input
Output