Demo Personalization workflow

Discover Saleo Live demos, retrieve personalization tokens, and create or maintain personalized views of them programmatically.

1. Overview

The Saleo Public API lets an authorized integration discover Saleo Live demo templates, inspect their text personalization tokens, create personalized views with token overrides, and update those views later — all outside the Saleo Portal.

Support Operations

2. Authentication

All requests require a bearer token:

Authorization: Bearer <user_api_key>

Unlike team-wide tokens, this API uses user API keys. A user API key is bound to the Saleo user who created it: every call acts as that user, sees only the demos they can see, and creates views owned by them.

Creating and managing your key

• Any user can create their own key in the Saleo Portal: profile menu → API Keys → Create My API Key. The key value is shown only once, at creation — copy it immediately; it cannot be retrieved later.

• Each user can hold one active key at a time. To rotate, revoke the existing key and create a new one.

• Revoking a key is permanent and takes effect on its next request. Keys can also be renamed to record what they're used for.

• Admins can see and revoke every key on the team under Settings → Manage SCIM/API Access Tokens, including when each was last used. Non-admin users only see their own key.

• A key stops working the moment its user is deactivated.

Security Recommendation

Call this API from your own backend or approved integration layer, not directly from an untrusted browser client. Store the API key the same way you'd store any credential — encrypted at rest, never embedded in front-end code — and rotate it if it may have been exposed.

3. Quick start: create a personalized demo view

Step 1 — Find a personalizable demo

curl --request POST \
  --url https://api.platform.saleo.io/v1/get_live_demos \
  --header "Authorization: Bearer $SALEO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "search": "EA-4711",
    "personalizableOnly": true,
    "limit": 25
  }'
{
  "data": [
    {
      "id": "d3f2a1b0-...",
      "name": "EA-4711 ACME Overview",
      "tags": ["Retail"],
      "owner": { "userId": "u-1", "name": "Sally Seller", "email": "rep@acme.com" },
      "personalizable": true,
      "personalizedView": false,
      "playUrl": "https://.../play/d3f2a1b0-...",
      "createdAt": "2026-07-07T12:00:00Z",
      "updatedAt": "2026-07-07T12:00:00Z"
    }
  ]
}

Step 2 — List the template's tokens

curl --request POST \
  --url https://api.platform.saleo.io/v1/get_demo_tokens \
  --header "Authorization: Bearer $SALEO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "demoId": "d3f2a1b0-..." }'
{
  "data": [
    { "id": "t-company", "name": "%%company%%", "description": "Customer name",
      "tags": ["Company Info"], "value": "ACME", "overridden": false }
  ]
}

Step 3 — Create a personalized view

curl --request POST \
  --url https://api.platform.saleo.io/v1/create_personalized_view \
  --header "Authorization: Bearer $SALEO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "demoId": "d3f2a1b0-...",
    "name": "ACME for Globex",
    "tokenValues": [ { "tokenId": "t-company", "value": "Globex" } ]
  }'
{
  "view": { "id": "v-0000-...", "name": "ACME for Globex",
    "personalizedView": true, "parentDemoId": "d3f2a1b0-...",
    "playUrl": "https://.../play/v-0000-..." },
  "appliedTokens": [
    { "id": "t-company", "name": "%%company%%", "value": "Globex", "overridden": true }
  ]
}

Step 4 — Update it later

Use the same view id to refresh token values or rename the view as the deal changes — see update_personalized_view below.

4. Endpoint reference

POST /v1/get_live_demos

Returns the demos the key's user works with: personalizable templates they can view, plus their personalized views — the ones they created and any shared with them. Returned newest-created first.

POST /v1/get_demo_tokens

Returns the text tokens of a template or a personalized view — tokens declared at any level of the demo's parent chain are included. Image tokens are not returned; this API personalizes text only.

POST /v1/create_personalized_view

Creates a personalized view of a template: a private copy owned by the key's user, carrying the requested token values. Only visible to its creator until shared in the portal.

POST /v1/update_personalized_view

Changes token values on a view that already exists, and optionally renames it, so an integration can keep one view id and refresh it as the deal changes. Only the user who created a view can change it.

5. Error format

All error responses share this shape. The HTTP status carries the error class; the body's code field is the corresponding gRPC status number.

{
  "code": 5,
  "error": "Personalized view not found"
}

6. Integration recommendations

• Run Saleo API calls from your own backend service or approved integration layer, not directly from an untrusted browser client.

• Map your own business identifiers (transaction, conversation, opportunity, or workflow id) to Saleo demoId and viewId values in a durable integration table.

• Cache demo discovery results briefly, but re-read tokens before personalizing when template authors may have changed them.

• Validate that a selected demo is personalizable before creating a view.

• Treat playUrl as the base launch URL returned by Saleo — append your own ?startUrl= parameter before sharing it, rather than reconstructing the rest of the URL yourself.

• Since create and update calls fail atomically, validate token ids and values client-side before sending to avoid unnecessary round trips.