Workspaces
Update Workspace Profile
Changes the company profile. Send only the fields to change; lists replace the stored list.
https://app.tryredrover.com/api/public/v1/workspace/profileworkspace:writeHeaders
AuthorizationstringRequiredBearerfollowed by anrr_live_API key or a connected app's access token. See Authentication.X-Workspace-IdstringRequiredThe workspace to act on, from List Workspaces.
UUID
Body
websitestringCompany website, like example.com
up to 500 characters
descriptionstringWhat 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 FieldsHide Child Fields
namestringRequired1 to 200 characters
websitestringRequiredup to 500 characters
brandNamesstring[]Brand names our checks should accept. Replaces the whole list
Response
200 The profile after the change.
dataobjectRequiredShow 8 Child FieldsHide Child Fields
idstringRequiredWorkspace ID
namestringRequiredCompany or workspace name
websitestringRequiredCompany website
nullable
descriptionstringRequiredWhat the company does
nullable
keywordsstring[]RequiredTarget keywords
subredditsstring[]RequiredSubreddits to focus on, as bare names
competitorsobject[]RequiredTracked competitors
Show 2 Child FieldsHide Child Fields
namestringRequiredwebsitestringRequired
brandNamesstring[]RequiredBrand names our checks accept in content
Errors
Every error uses the error envelope.
400No field was sent, or a field is invalid401The Authorization header is missing, or the key is invalid or revoked403The key lacks the endpoint's scope, or cannot reach the workspace429More than 120 requests in a minute. Wait for Retry-After seconds500Something 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"
]
}'{
"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"
]
}
}