Accounts
addTag
accounts.addTag
Add a tag to an account
Risk: write
data full type
data full type
create
accounts.create
Create an account
Risk: write
attributes full type
attributes full type
data full type
data full type
get
accounts.get
Read one account by id
Risk: read
data full type
data full type
list
accounts.list
List accounts, filtered by reference id, page by page
Risk: read
data full type
data full type
links full type
links full type
redact
accounts.redact
Redact an account; the data is permanently removed
Risk: destructive · Irreversible
data full type
data full type
removeTag
accounts.removeTag
Remove a tag from an account
Risk: write
data full type
data full type
search
accounts.search
Search accounts with a predicate query
Risk: read
sort full type
sort full type
page full type
page full type
data full type
data full type
links full type
links full type
update
accounts.update
Update an account’s attributes, status or tags
Risk: write
attributes full type
attributes full type
data full type
data full type
Inquiries
addTag
inquiries.addTag
Add a tag to an inquiry
Risk: write
data full type
data full type
approve
inquiries.approve
Approve an inquiry; the decision is final and runs any approval workflow
Risk: destructive · Irreversible
data full type
data full type
create
inquiries.create
Create an inquiry from a template
Risk: write
attributes full type
attributes full type
meta full type
meta full type
data full type
data full type
decline
inquiries.decline
Decline an inquiry; the decision is final
Risk: destructive · Irreversible
data full type
data full type
generateOneTimeLink
inquiries.generateOneTimeLink
Generate a one-time link for an inquiry; anyone with the link can resume it
Risk: write
data full type
data full type
meta full type
meta full type
get
inquiries.get
Read one inquiry by id
Risk: read
data full type
data full type
list
inquiries.list
List inquiries filtered by status, account, reference or template
Risk: read
data full type
data full type
links full type
links full type
markForReview
inquiries.markForReview
Mark an inquiry for manual review
Risk: write
data full type
data full type
redact
inquiries.redact
Redact an inquiry; the data is permanently removed
Risk: destructive · Irreversible
data full type
data full type
removeTag
inquiries.removeTag
Remove a tag from an inquiry
Risk: write
data full type
data full type
update
inquiries.update
Update inquiry attributes
Risk: write
attributes full type
attributes full type
data full type
data full type
Inquiry Sessions
create
inquirySessions.create
Create a session for an inquiry
Risk: write
data full type
data full type
expire
inquirySessions.expire
Expire one inquiry session
Risk: write
data full type
data full type
expireAll
inquirySessions.expireAll
Expire every session of the given inquiries
Risk: destructive · Irreversible
data full type
data full type
generateOneTimeLink
inquirySessions.generateOneTimeLink
Generate a one-time link for an inquiry session
Risk: write
data full type
data full type
meta full type
meta full type
get
inquirySessions.get
Read one inquiry session
Risk: read
data full type
data full type
Inquiry Templates
get
inquiryTemplates.get
Read one inquiry template
Risk: read
data full type
data full type
list
inquiryTemplates.list
List the inquiry templates
Risk: read
data full type
data full type
links full type
links full type
listVersions
inquiryTemplates.listVersions
List the versions of one inquiry template
Risk: read
data full type
data full type
links full type
links full type
Webhooks
archive
webhooks.archive
Archive a webhook; archived webhooks cannot be re-enabled
Risk: destructive · Irreversible
data full type
data full type
create
webhooks.create
Create a webhook; the answer carries its signing secret
Risk: write
attributes full type
attributes full type
data full type
data full type
disable
webhooks.disable
Disable a webhook; deliveries stop until it is enabled again
Risk: write
data full type
data full type
enable
webhooks.enable
Enable a webhook
Risk: write
data full type
data full type
get
webhooks.get
Read one webhook
Risk: read
data full type
data full type
list
webhooks.list
List the webhooks
Risk: read
data full type
data full type
links full type
links full type
rotateSecret
webhooks.rotateSecret
Rotate the webhook signing secret; the old one stops signing once its window ends
Risk: destructive · Irreversible
data full type
data full type
searchEvents
webhooks.searchEvents
Search recorded webhook events
Risk: read
sort full type
sort full type
page full type
page full type
data full type
data full type
links full type
links full type
update
webhooks.update
Update a webhook URL, name or subscribed events
Risk: write
attributes full type
attributes full type
data full type
data full type