Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Update the company

Renames the company, sets its logo, picks the AI plan its teammates run on, picks where their names come from, answers setup's survey, or sets the legal details; send any of them. Changing the plan keeps the old one signed in on each computer, as the first fallback. A new troopNames renames every teammate still going by a theme's name or its job title; ones a person named keep theirs. profile changes only the answers it names. Needs an owner or admin.

patch/api/v1/company

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy company update
MCP tooltroopy_update_company
Rate limit30 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Body

application/json
namestring

The new name, 1 to 80 characters

At least 1 characters · At most 80 characters

aiProviderenum<string>

The AI plan the company's teammates run on

claudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor

troopNamesenum<string>

The theme new teammates' names come from, or titles for their job titles

titlesgreek-mythgreek-heroesnorsecamelotspacescientistsexplorersauthorscomposersbirdstreesoceangemstonesspicescoffeeand 11 more

profileobject

Survey answers to set; the others stay as they are

8 properties
teamSizeenum<string>

How many people work in the business

solo2_1011_5051_200over_200

revenueenum<string>

Monthly revenue, in USD

noneunder_10k10k_50k50k_250k250k_1mover_1m

jobRoleenum<string>

The role of whoever answered

founderexecutivemarketingsalesoperationssupportproductagencyother

businessModelenum<string>

saasecommerceagencyserviceslocalmarketplacecreatorother

industriesarray<enum<string>>

technologyretailhealthfinanceeducationreal_estatehospitalitymediaprofessionalother

At most 10 items

reasonenum<string>

The main reason they signed up

save_timefewer_toolsgrow_without_hiringalways_onexplore_aiother

jobsarray<enum<string>>

What they want their teammates to do

outreachlead_researchsupportsocialcontentseoemailbookkeepingrecruitingreportingengineering

At most 11 items

referralsarray<enum<string>>

How they heard about Troopy

googleai_assistantxlinkedinyoutuberedditproduct_huntfriendnewsletterother

At most 10 items

legalobject

Legal details to set; the others stay as they are. An empty text clears its field

8 properties
legalNamestring | null

The registered name of the company

entityTypestring | null

The legal form, like BV, GmbH, Ltd or LLC

registrationNumberstring | null

The number in the register of companies

addressstring | null

The registered address

countrystring | null

The country of the company, ISO 3166-1 alpha-2, like NL

currencystring | null

The currency of the books of the company, ISO 4217, like EUR. Its totals are in it

taxIdsarray<object>

The tax ids of the company, like VAT or EIN, 5 at most. Data of the business, not a secret

At most 5 items

2 properties
label*string

At least 1 characters · At most 40 characters

value*string

At least 1 characters · At most 60 characters

fiscalYearStartinteger

The month that the fiscal year starts in: 1 is January

At least 1 · At most 12

logostring | null

The company's logo: a PNG, JPEG or WebP image of at most 1 MB, base64-encoded. null removes it

Response

200 · application/json
data*object
8 properties
id*string

A 24-character id

name*string
role*enum<string>

Role in the company. Owners and admins reach every workspace in it, and manage its people. A member reaches only the workspaces that someone invited it into. An accountant reaches no workspace: it reads the Portfolio and the reports of the company in the app, and changes nothing

owneradminmemberaccountant

aiProvider*enum<string> | null

The AI plan teammates run on. Null until setup picks one

claudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor

troopNames*enum<string> | null

Where new teammates' names come from: a theme, or their job titles (titles). Null until setup asks, which names them by job title

titlesgreek-mythgreek-heroesnorsecamelotspacescientistsexplorersauthorscomposersbirdstreesoceangemstonesspicescoffeeand 11 more

profile*object

Setup's survey about the business. Unanswered questions are missing

8 properties
teamSizeenum<string>

How many people work in the business

solo2_1011_5051_200over_200

revenueenum<string>

Monthly revenue, in USD

noneunder_10k10k_50k50k_250k250k_1mover_1m

jobRoleenum<string>

The role of whoever answered

founderexecutivemarketingsalesoperationssupportproductagencyother

businessModelenum<string>

saasecommerceagencyserviceslocalmarketplacecreatorother

industriesarray<enum<string>>

technologyretailhealthfinanceeducationreal_estatehospitalitymediaprofessionalother

At most 10 items

reasonenum<string>

The main reason they signed up

save_timefewer_toolsgrow_without_hiringalways_onexplore_aiother

jobsarray<enum<string>>

What they want their teammates to do

outreachlead_researchsupportsocialcontentseoemailbookkeepingrecruitingreportingengineering

At most 11 items

referralsarray<enum<string>>

How they heard about Troopy

googleai_assistantxlinkedinyoutuberedditproduct_huntfriendnewsletterother

At most 10 items

legal*object | null

The legal details of the company: its legal entity. Null for a person who is not an owner or admin

8 properties
legalName*string | null

The registered name of the company

entityType*string | null

The legal form, like BV, GmbH, Ltd or LLC

registrationNumber*string | null

The number in the register of companies

address*string | null

The registered address

country*string | null

The country of the company, ISO 3166-1 alpha-2, like NL

currency*string | null

The currency of the books of the company, ISO 4217, like EUR. Its totals are in it

taxIds*array<object>

The tax ids of the company, like VAT or EIN, 5 at most. Data of the business, not a secret

At most 5 items

2 properties
label*string

At least 1 characters · At most 40 characters

value*string

At least 1 characters · At most 60 characters

fiscalYearStart*integer

The month that the fiscal year starts in: 1 is January

At least 1 · At most 12

logoUrl*string | null

A public link to the company's logo, or null when it has none

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask a company owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.