Workspace

Correct workspace onboarding assumptions and settings

Required permissions: settings:write.

Partial update: send only the fields you are changing. solutionItems and stakeholderPersonas replace complete structured lists and regenerate their prose projections atomically. Pass the latest revision as expectedRevision for list edits, and re-read and merge on a 409 conflict. Changing solutions clears an omitted solutionsBrief rather than leaving an outdated summary. buyerProfile patches only supplied ICP assumptions, including nested geography and sizeBand. Legacy prose fields accept null to clear, but a direct prose edit discards the matching structured cards. Do not send both forms of the same setting. Discovery uses the saved values on future work.

Write the definition as prose, the way you would brief a new researcher: the roles that own or buy what you sell, the roles that influence the decision, and the roles to skip. Example: "Heads of platform, infrastructure, DevOps or SRE, and the VP or Director of Engineering they report to. Not recruiters, not IT, not security, not individual engineers."

The stakeholder definition is what makes stakeholder search yours. Two stages read it. The account-level search that runs when a company is added to the workspace turns it into search keywords and selects people at the company against it; without a definition that search seeds on seniority alone (chiefs, VPs, directors of any function). The per-event stage that a discovery run started with people: "add" runs attaches people, with a per-person reasoning, to each event; without a definition that stage does not run at all and expand=people is [] on every event.

Set it FIRST — before you add accounts, and before you run discovery. It steers work that starts after it is set and is never applied retroactively, and the account-level search for a company starts the moment that company is added. An account added before the definition existed keeps the people that search found for it then; the way to search it against the new definition is POST /v1/stakeholders/search.

patch/v1/workspace

Request

  • Base URL: https://api.trayo.ai
  • URL: https://api.trayo.ai/v1/workspace
  • Auth: HTTP bearer

Request body

expectedRevisionstring

The revision returned by trayo_get_workspace or GET /v1/workspace. Required for full-list replacements. A stale revision returns 409; re-read and merge instead of retrying the old list.

stakeholderCriteriastring nullable

Plain prose describing the roles to find and the roles to skip, e.g. "Heads of platform, infrastructure, DevOps or SRE, and the VP or Director of Engineering they report to. Not recruiters, not IT, not individual engineers." Send null to clear it.

solutionsstring nullable

What you sell, in prose. Send null to clear it.

solutionsBriefstring nullable

A one- or two-sentence version of solutions. Send null to clear it. If solutions or solutionItems change and this is omitted, the old brief is cleared. Do not re-send an old brief that may be inaccurate after the change.

Response

The settings as they now stand.

idstring uuid required

The workspace your key acts in.

namestring required

The workspace name, as the Trayo app shows it. Read-only here.

revisionstring required

Opaque version of the saved onboarding settings. Pass it as expectedRevision when replacing solution or persona lists; re-read on conflict.

stakeholderCriteriastring nullable required

Your stakeholder definition, in plain prose: who buys, owns, or influences what you sell, and who does not. It steers BOTH stakeholder stages — the account-level search that runs when a company is added to the workspace, and the per-event people (with reasoning) a discovery run started with people: "add" attaches. Null until set: the account-level search then seeds on seniority alone and no people are attached to events.

solutionsstring nullable required

What you sell, in prose. Read by the reasoning that explains why a person or event matters, and by the app when it drafts a stakeholder definition. Null until set.

solutionsBriefstring nullable required

A one- or two-sentence version of solutions. Null until set.

buyerProfileSource'saved' | 'partial' | 'inferred' | 'unreadable' required

saved: read from onboarding's stored ICP. partial: the fields sent to this API are the caller's own; every field never sent is still the placeholder below. inferred: nothing was saved, so you got a fixed placeholder — the same wide defaults for every workspace, not read from your site or your name. unreadable: an ICP is saved but not in a shape this API can read, so you got that same placeholder and patching is refused; edit it in the Trayo app. Only saved fields and fields you supplied yourself are facts about this workspace; confirm the rest before relying on them.

Changes

No recorded changes to this operation across all 1 revision of this API.