Workspaces

Put Profile

Create or update the profile (admin+). Omitted fields are unchanged; `null` or blank text clears a field; `icp` replaces the whole ICP. 422 for an invalid website.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PUT/api/v1/workspaces/current/profile
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

website?string | null

Company website; https:// is added when no scheme is given.

Lengthlength <= 2048
company_description?string | null
Lengthlength <= 4000
offer?string | null
Lengthlength <= 4000
icp?Icp | null
tone?Tone | null
persona_name?string | null
Lengthlength <= 80
email_approval?EmailApproval | null
postal_address?string | null

Physical mailing address shown in marketing email footers (CAN-SPAM).

Lengthlength <= 500
onboarding_step?OnboardingStep | null
onboarding_completed?boolean | null

true marks onboarding complete (first timestamp kept); false re-opens it.

Response Body

curl -X PUT "http://localhost:8000/api/v1/workspaces/current/profile" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "website": "string",
  "company_description": "string",
  "offer": "string",
  "icp": {
    "industries": [
      [
        "B2B SaaS",
        "IT services"
      ]
    ],
    "company_sizes": [
      "1-10"
    ],
    "titles": [
      [
        "Head of Sales"
      ]
    ],
    "geos": [
      [
        "US",
        "DACH"
      ]
    ],
    "pain_points": [
      [
        "Not enough qualified pipeline"
      ]
    ]
  },
  "tone": {},
  "persona_name": "string",
  "email_approval": "all_steps",
  "postal_address": "string",
  "onboarding_step": {},
  "onboarding_completed_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}