Skip to main content
Read and change how OpenCX works with Salesforce: Case management behaviour (assist drafts and their From address, Case-field auto-fill, Case comments, first-email content) and the messaging (MIAW) deployment. Connecting Salesforce and changing credentials happen in Settings → Ticketing; OAuth tokens, the Connected App secret, and the messaging private key are never returned.

Key Concepts

  • Not connected — reads answer 200 with connected: false; updates answer 404
  • Partial updates — omitted fields keep their value
  • Two sections — case_management and miaw are each null when that side is not connected; updating a section that is not connected answers 400
  • Draft From address — must be one of the verified org-wide addresses

Available Endpoints

Get settings

Read the Salesforce Case management and messaging settings.

Update settings

Change Salesforce Case management or messaging settings. Omitted fields keep their value.

List org-wide addresses

List the verified org-wide email addresses of the connected Salesforce org, to pick the From address of assist drafts.