Skip to main content

Analyse Comms

Analyse Comms is the second step in the Wize Snap API flow.

Use it when you already have a predicted profile and want to review a draft message against that profile.

What It Does​

POST /api/v1/snap/comms accepts a message, a message type, and a profile reference — either the snapId returned by Predict Profile, or a primaryCode (with an optional secondaryCode) directly.

Full endpoint: https://backend.snap.wizer.business/api/v1/snap/comms

The endpoint returns communication analysis that can guide clearer outreach, internal messaging, meeting preparation, or difficult conversations.

Two Ways To Reference A Profile​

Send exactly one of these — never both, never neither:

  • snapId — Best when you already ran Predict Profile and want the analysis tied to that stored snap. The backend reads the profile straight from the snap record, and a comms record is created (or updated, on repeat calls) so you can look up the analysis later via commsId.
  • primaryCode / secondaryCode — Best for a one-off analysis when you already know the decision profile — for example, you captured primary_code / secondary_code from a prior Predict Profile response and don't want to store a snap for this call. Nothing is persisted server-side, so the response always has commsId: null. See the full list of codes in the API Reference.

Supported Message Types​

  • outreach
  • text
  • email
  • internal_comms
  • difficult_conversation
  • meeting_prep
  1. Get a profile reference — either a snapId from Predict Profile, or a primaryCode/secondaryCode pair you already have.
  2. Collect the message draft from your app.
  3. Send messageType, messageText, and your chosen profile reference to POST /api/v1/snap/comms.
  4. Show the analysis inside your communication workflow.

Practical Tips​

  • Choose the closest messageType; it helps shape the analysis.
  • Send the exact message text the user wants reviewed.
  • Use snapId when you want the analysis retrievable later by commsId; use primaryCode/secondaryCode for stateless, one-off analysis.
  • secondaryCode is only honored alongside primaryCode — it has no effect if you also send snapId.
  • DP-07 (Visionary) cannot be used as secondaryCode.
  • Each call costs 2 API credits, regardless of whether you use snapId or primaryCode — see API Reference.