RedRover Logo

Workspaces

Update Workspace Profile

Changes the company profile. Send only the fields to change; lists replace the stored list.

PATCH/workspace/profile
Scope: workspace:write

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Body

  • websitestring

    Company website, like example.com

    up to 500 characters

  • descriptionstring

    What the company does, up to 5,000 characters

    up to 5000 characters

  • keywordsstring[]

    Target keywords. Replaces the whole list

    up to 200 items

  • subredditsstring[]

    Subreddits to focus on, with or without r/. Replaces the whole list

    up to 200 items

  • competitorsobject[]

    Competitors as { name, website }. Replaces the whole list

    up to 25 items

    Show 2 Child Fields
    • namestringRequired

      1 to 200 characters

    • websitestringRequired

      up to 500 characters

  • brandNamesstring[]

    Brand names our checks should accept. Replaces the whole list

Response

200 The profile after the change.

  • dataobjectRequired
    Show 8 Child Fields
    • idstringRequired

      Workspace ID

    • namestringRequired

      Company or workspace name

    • websitestringRequired

      Company website

      nullable

    • descriptionstringRequired

      What the company does

      nullable

    • keywordsstring[]Required

      Target keywords

    • subredditsstring[]Required

      Subreddits to focus on, as bare names

    • competitorsobject[]Required

      Tracked competitors

      Show 2 Child Fields
      • namestringRequired
      • websitestringRequired
    • brandNamesstring[]Required

      Brand names our checks accept in content

Errors

Every error uses the error envelope.

  • 400No field was sent, or a field is invalid
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl -X PATCH "https://app.tryredrover.com/api/public/v1/workspace/profile" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "product analytics",
    "saas metrics",
    "churn"
  ]
}'
200 Response
{
  "data": {
    "id": "8f14e45f-ceea-4e1a-9c2b-6d7a1c3b9e21",
    "name": "Acme Analytics",
    "website": "https://acme.example",
    "description": "Product analytics for small SaaS teams.",
    "keywords": [
      "product analytics",
      "saas metrics",
      "churn"
    ],
    "subreddits": [
      "startups",
      "SaaS"
    ],
    "competitors": [
      {
        "name": "Example Metrics",
        "website": "https://metrics.example"
      }
    ],
    "brandNames": [
      "Acme",
      "Acme Analytics"
    ]
  }
}