Jump to Content
Home
API Reference
v1.0
API Reference
API Reference
API Reference
v1.0
Home
API Reference
/main/recommendations/{id}/
Search
JUMP TO
API
auth
/auth/login/
post
/auth/logout/
post
integrations
/integrations/aircall/users/
get
/integrations/aircall/users/availabilities/
get
/integrations/aircall/users/{user_id}/dialer_campaign/
get
/integrations/aircall/users/{user_id}/dialer_campaign/
post
/integrations/aircall/users/{user_id}/dialer_campaign/
del
/integrations/aircall/users/{user_id}/dialer_campaign/phone_numbers/
get
/integrations/aircall/users/{user_id}/dialer_campaign/phone_numbers/
post
/integrations/aircall/users/{user_id}/dialer_campaign/phone_numbers/{phone_number_id}/
del
/integrations/airslate/organizations/
get
/integrations/airslate/organizations/
post
/integrations/airslate/organizations/{organization_id}/forms/templates/
put
/integrations/airslate/organizations/{organization_id}/groups/
get
/integrations/airslate/organizations/{organization_id}/groups/
post
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/
get
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/
del
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/members/
get
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/members/
post
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/members/{user_id}/
patch
/integrations/airslate/organizations/{organization_id}/groups/{group_id}/members/{user_id}/
del
/integrations/airslate/organizations/{organization_id}/settings/
get
/integrations/airslate/organizations/{organization_id}/settings/
patch
/integrations/airslate/organizations/{organization_id}/templates/
get
/integrations/airslate/organizations/{organization_id}/templates/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/
patch
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/distribute/
patch
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/documents/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/documents/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/documents/{document_id}/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/documents/{document_id}/
patch
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/documents/{document_id}/
del
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/flows/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/flows/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/flows/{flow_id}/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/flows/{flow_id}/download/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/flows/{flow_id}/share/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/forms/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/forms/{form_id}/
put
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/versions/
get
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/versions/
post
/integrations/airslate/organizations/{organization_id}/templates/{template_id}/versions/{version_id}/publish/
patch
/integrations/airslate/organizations/{organization_id}/users/
get
/integrations/airslate/organizations/{organization_id}/users/invite/
post
/integrations/airslate/organizations/{organization_id}/users/{user_id}/
get
/integrations/airslate/organizations/{organization_id}/users/{user_id}/
del
/integrations/airslate/organizations/{organization_id}/users/{user_id}/reject-invite/
del
/integrations/airslate/us-legal/categories/
get
/integrations/airslate/us-legal/categories/{category_id}/
get
/integrations/airslate/us-legal/files/
get
/integrations/airslate/us-legal/files/{form_file_id}/
get
/integrations/airslate/us-legal/files/{form_file_id}/download/{file_format}/
get
/integrations/airslate/us-legal/forms/
get
/integrations/airslate/us-legal/forms/{form_id}/
get
/integrations/airslate/us-legal/packages/
get
/integrations/airslate/us-legal/packages/{package_id}/
get
/integrations/airslate/us-legal/packages/{package_id}/download/{file_format}/
get
/integrations/airslate/us-legal/previews/
get
/integrations/airslate/us-legal/previews/{preview_form_id}/
get
/integrations/airslate/us-legal/search/
post
/integrations/builwith/get_technologies/
post
Fetch popular integrations by category based on provided company data.
post
/integrations/convert/pdf-image-to-text/
post
/integrations/forms/contact-us/
post
/integrations/forms/hubspot-form/
post
/integrations/fresh-sales-integration/create_appointment/
post
/integrations/fresh-sales-integration/delete_appointment/{id_appointment}/
del
/integrations/fresh-sales-integration/list_all_appointments/
get
/integrations/fresh-sales-integration/update_appointment/{id_appointment}/
patch
/integrations/fresh-sales-integration/view_appointment/{id_appointment}/
get
/integrations/fresh-sales/contacts/
post
/integrations/freshdesk/create/
post
/integrations/hubspot/associate-contact-company/
post
/integrations/hubspot/create-company/
post
/integrations/hubspot/create-deal/
post
/integrations/hubspot/create_contact/
post
/integrations/hubspot/create_meeting/
post
/integrations/hubspot/delete-deal/{deal_id}/
del
/integrations/hubspot/delete_contact/{contact_id}/
del
/integrations/hubspot/delete_meeting/{meeting_id}/
del
/integrations/hubspot/get-contacts-by-identifier/
post
/integrations/hubspot/list-owners/
get
/integrations/hubspot/retrieve-all-deals/
get
/integrations/hubspot/retrieve-deal/{deal_id}/
get
/integrations/hubspot/retrieve-list-companies/
get
/integrations/hubspot/retrieve-owner/{owner_id}/
get
/integrations/hubspot/retrieve_contact/{contact_id}/
get
/integrations/hubspot/retrieve_list_contact/
get
/integrations/hubspot/retrieve_list_meetings/
get
/integrations/hubspot/retrieve_meeting/{meeting_id}/
get
/integrations/hubspot/submit-form-data/{portal_id}/{form_id}/
post
/integrations/hubspot/update-company/{company_id}/
patch
/integrations/hubspot/update-deal/{deal_id}/
patch
/integrations/hubspot/update_contact/{contact_id}/
patch
/integrations/hubspot/update_meetings/{meeting_id}/
patch
/integrations/legal/llc-details/
post
/integrations/legal/registered-agent/
post
/integrations/openai/ask-gpt/
post
/integrations/openai/assistant/{assistant_id}/thread/{thread_id}/run/
post
/integrations/openai/file/{openai_file_id}/
get
/integrations/openai/file/{openai_file_id}/
del
/integrations/openai/file/{openai_file_id}/content/
get
/integrations/openai/thread/
post
/integrations/openai/thread/
del
/integrations/openai/thread/{thread_id}/message/
get
/integrations/openai/thread/{thread_id}/message/
post
/integrations/openai/thread/{thread_id}/run/{run_id}/
get
/integrations/openai/upload-file/
post
/integrations/proposal/create-proposal/
post
/integrations/proposal/delete-proposal/
del
/integrations/proposal/get-proposal/
get
/integrations/slack/
get
/integrations/slack/create-slack-channel/
post
/integrations/slack/{id}/
get
/integrations/slack/{id}/add-members/
post
/integrations/slack/{id}/invite-client/
post
/integrations/smstoslack/send-sms-and-post-to-slack/
post
/integrations/webpilot/retrieve/
post
main
/main/automation-alternative/
get
/main/automation-alternative/alternative/{automation_id}/
get
/main/automation-alternative/{id}/
get
/main/automations/
get
/main/automations/{id}/
get
/main/automations/{id}/
put
/main/automations/{id}/
patch
/main/automations/{id}/
del
/main/bots/
get
/main/bots/
post
/main/bots/no-live-mode/
get
/main/bots/{bot}/conversations/
get
/main/bots/{bot}/conversations/
post
/main/bots/{bot}/conversations/export-csv/
get
/main/bots/{bot}/conversations/workflow/
post
/main/bots/{bot}/conversations/{id}/
get
/main/bots/{bot}/customer-files/
get
/main/bots/{bot}/customer-files/
post
/main/bots/{bot}/customer-files/{id}/
get
/main/bots/{id}/
get
/main/bots/{id}/
put
/main/bots/{id}/
patch
/main/bots/{id}/
del
/main/bots/{id}/automations/
get
/main/bots/{id}/automations/
post
/main/bots/{id}/automations/
del
/main/bots/{id}/origins/allowed/
post
/main/bots/{id}/origins/allowed/
del
/main/bots/{id}/origins/blocked/
post
/main/bots/{id}/origins/blocked/
del
/main/bots/{id}/usage/
get
/main/bots/{id}/used-in/
get
/main/bots/{id}/widget/
get
/main/bots/{id}/widget/check/
get
/main/conversations/{conversation}/messages/
get
/main/conversations/{conversation}/messages/
post
/main/conversations/{conversation}/messages/{id}/
get
/main/conversations/{id}/
get
/main/conversations/{id}/
put
/main/conversations/{id}/
patch
/main/conversations/{id}/dispute-charge/
post
/main/conversations/{id}/forms/
post
### Human Handoff
post
/main/conversations/{id}/input/add/
post
/main/conversations/{id}/surveys/
post
/main/conversations/{id}/view/
post
/main/emails-handoff/
get
/main/emails-handoff/
post
/main/emails-handoff/{id}/
get
/main/emails-handoff/{id}/
put
/main/emails-handoff/{id}/
patch
/main/emails-handoff/{id}/
del
/main/emails/mailgun/
post
/main/emails/privacy/
post
/main/faqs-negative/
get
/main/faqs-negative/
post
/main/faqs-negative/bulk-create/
post
/main/faqs-negative/{id}/
get
/main/faqs-negative/{id}/
put
/main/faqs-negative/{id}/
patch
/main/faqs-negative/{id}/
del
/main/faqs-positive/
get
/main/faqs-positive/
post
/main/faqs-positive/{id}/
get
/main/faqs-positive/{id}/
put
/main/faqs-positive/{id}/
patch
/main/faqs-positive/{id}/
del
/main/faqs/
get
/main/faqs/matches/
get
/main/faqs/{id}/
get
/main/faqs/{id}/
put
/main/faqs/{id}/
patch
/main/faqs/{id}/
del
/main/faqs/{id}/negatives/
get
/main/faqs/{id}/positives/
get
/main/human-handoff/
get
/main/human-handoff/
post
/main/human-handoff/{id}/
get
/main/human-handoff/{id}/
put
/main/human-handoff/{id}/
patch
/main/human-handoff/{id}/
del
/main/integration-templates/
get
/main/integration-templates/{id}/
get
/main/integration-templates/{id}/add/
post
/main/integration-templates/{id}/automations/
get
/main/integration-templates/{id}/automations/{automation}/add/
post
/main/integration-templates/{id}/confirm_creds_oauth2/
post
/main/integrations/
get
/main/integrations/
post
/main/integrations/list-integrations-human-handoff/
get
/main/integrations/{id}/
get
/main/integrations/{id}/
put
/main/integrations/{id}/
patch
/main/integrations/{id}/
del
/main/integrations/{id}/automations/
get
/main/integrations/{id}/automations/
post
/main/knowledge-faq-history/
get
/main/knowledge-faq-history/knowledge-faq/{knowledgefaq}/
get
/main/knowledge-faq-history/{id}/
get
/main/knowledge-faq-history/{id}/rollback_to_version/
post
/main/knowledge/
get
/main/knowledge/
post
/main/knowledge/attachments/image/
post
/main/knowledge/{id}/
get
/main/knowledge/{id}/
del
/main/legal/appointment/
get
/main/legal/appointment/
post
/main/legal/appointment/{id}/
put
/main/legal/appointment/{id}/
patch
/main/legal/appointment/{id}/
del
/main/legal/case/
get
/main/legal/case/
post
/main/legal/case/available/
get
/main/legal/case/base-budget/
get
/main/legal/case/download/{link_id}/
get
/main/legal/case/lawyer/{lawyer_id}/
get
/main/legal/case/{case_id}/file/
get
/main/legal/case/{case_id}/file/
post
/main/legal/case/{case_id}/file/lawyer/
post
/main/legal/case/{case_id}/file/{id}/
get
/main/legal/case/{case_id}/file/{id}/
put
/main/legal/case/{case_id}/file/{id}/
patch
/main/legal/case/{case_id}/workflow/
get
/main/legal/case/{case_id}/workflow/
post
/main/legal/case/{case_id}/workflow/{id}/
put
/main/legal/case/{case_id}/workflow/{id}/
patch
/main/legal/case/{case_id}/workflow/{id}/step/
get
/main/legal/case/{case_id}/workflow/{id}/step/
post
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/
patch
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/
del
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/action/
get
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/action/
post
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/action/{action_id}/
patch
/main/legal/case/{case_id}/workflow/{id}/step/{step_id}/action/{action_id}/
del
/main/legal/case/{id}/
get
/main/legal/case/{id}/
put
/main/legal/case/{id}/
patch
/main/legal/case/{id}/agreement/
get
/main/legal/case/{id}/agreement/
post
/main/legal/case/{id}/user-data/
patch
/main/legal/dki/
get
/main/legal/dki/
post
/main/legal/documents/
get
/main/legal/documents/
post
/main/legal/documents/{id}/
get
/main/legal/documents/{id}/
put
/main/legal/documents/{id}/
del
/main/messages/{id}/
get
/main/messages/{id}/mark-human-handoff/
post
/main/messages/{id}/reaction/
post
/main/phone-numbers/
get
/main/phone-numbers/
post
/main/phone-numbers/available/
get
/main/phone-numbers/{id}/
get
/main/phone-numbers/{id}/
put
/main/phone-numbers/{id}/
patch
/main/prompts/
get
/main/prompts/
post
/main/prompts/{id}/
get
/main/prompts/{id}/
put
/main/prompts/{id}/
patch
/main/prompts/{id}/
del
/main/recommendations/
get
/main/recommendations/
post
/main/recommendations/expand-answer/
post
/main/recommendations/{id}/
get
/main/recommendations/{id}/
put
/main/recommendations/{id}/
patch
/main/recommendations/{id}/
del
/main/recommendations/{id}/accept-in-knowledge/
post
/main/recommendations/{id}/accept-in-workflow/
post
/main/recommendations/{id}/accept/
post
/main/recommendations/{id}/exclude/
post
/main/recommendations/{id}/messages/
get
/main/twilio/calls/
post
/main/twilio/calls/conversations/{id}/messages/
post
/main/twilio/calls/conversations/{id}/options/
post
/main/twilio/calls/conversations/{id}/response/
post
/main/twilio/calls/silence/
post
/main/workflow-templates/
get
/main/workflow-templates/create/
post
/main/workflow-templates/list/
get
/main/workflow-templates/retrieve/{template_id}/
get
/main/workflow-templates/{id}/
get
/main/workflow-templates/{id}/
put
/main/workflow-templates/{id}/
patch
/main/workflow-templates/{id}/add/
post
/main/workflow-usage/
get
/main/workflow-usage/workflow/{workflow_id}/
get
/main/workflow-usage/{id}/
get
/main/workflows-negative/
get
/main/workflows-negative/
post
/main/workflows-negative/bulk-create/
post
/main/workflows-negative/{id}/
get
/main/workflows-negative/{id}/
put
/main/workflows-negative/{id}/
patch
/main/workflows-negative/{id}/
del
/main/workflows/
get
/main/workflows/
post
/main/workflows/condition/parse/
post
/main/workflows/matches/
get
/main/workflows/{id}/
get
/main/workflows/{id}/
put
/main/workflows/{id}/
patch
/main/workflows/{id}/
del
/main/workflows/{id}/embed/
get
/main/workflows/{id}/negatives/
get
/main/workflows/{id}/run/
get
/main/workflows/{id}/run/
post
me
/me/
get
payments
/payments/payment-information/
get
/payments/payment-information/
post
/payments/payment-information/{id}/
get
/payments/payment-information/{id}/
del
/payments/payment-method/
get
/payments/payment-method/
post
/payments/payment-method/update/
post
/payments/prices/
get
/payments/prices/
post
/payments/prices/{id}/
get
/payments/prices/{id}/
del
/payments/seamlesschex/webhook/
post
/payments/shopify/validation/
post
/payments/square/cards/
get
/payments/square/cards/
post
/payments/square/cards/disable/{card_id}/
post
/payments/square/disputes/
get
/payments/square/invoice/
get
/payments/square/payments/
get
/payments/square/payments/
post
/payments/square/payments/cancel/{payment_id}/
post
/payments/square/payments/complete/{payment_id}/
post
/payments/square/payments/list-all/
get
/payments/square/refunds/refund/
get
/payments/square/refunds/refund/
post
/payments/square/subscriptions/
get
/payments/square/subscriptions/list-all/
get
/payments/square/subscriptions/subscription/{customer_id}/
get
/payments/square/subscriptions/subscriptions/{subscription_id}/
get
/payments/square/subscriptions/subscriptions/{subscription_id}/
del
/payments/square/subscriptions/subscriptions/{subscription_id}/cancel/
post
/payments/square/subscriptions/subscriptions/{subscription_id}/pause/
post
/payments/square/subscriptions/subscriptions/{subscription_id}/resume/
post
/payments/square/webhook/
post
/payments/stripe-payment-intent/
post
/payments/stripe-payments-history/
get
/payments/stripe-payments-history/bot/{bot_id}/
get
/payments/stripe-webhook/
post
/payments/subscription-items/
get
/payments/subscription-items/
post
/payments/subscription-items/{id}/
get
/payments/subscription-items/{id}/
del
/payments/subscriptions/
get
/payments/subscriptions/
post
/payments/subscriptions/{id}/
get
/payments/subscriptions/{id}/
del
/payments/yeslawyer/payment-auth/
post
/payments/yeslawyer/payment/
post
/payments/yeslawyer/refund/
post
/payments/yeslawyer/subscription/cancel/
post
/payments/yeslawyer/subscription/list/
get
task
/task/{task_id}/
get
webhooks
/webhooks/webhook-subscriptions/
post
/webhooks/webhook-subscriptions/{id}/
del
/webhooks/webhook-subscriptions/{id}/delete/
del
workflows
/workflows/zapier/create_zap/
post
/workflows/zapier/sample/cancel-subscription/
get
/workflows/zapier/sample/create-customer/
get
/workflows/zapier/sample/refund-order/
get
/workflows/zapier/sample/schedule/
get
/workflows/zapier/sample/send-email/
get
/workflows/zapier/zaps/
get
Powered by
/main/recommendations/{id}/
get
http://server-dev.deflection.ai/api/v1/main/recommendations/
{id}
/
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
base64
Basic
:
Response
Click
Try It!
to start a request and see the response here!