Update Company

Change your company name, description, timezone, or logo, or turn domain discovery on or off.

PUT

Path

Path parameters

stringrequired

The company id, from Who Am I? or List Companies. It has to be the company the request acts on: your key's company, or the child organization X-Company-Id names.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

string

A new name, up to 128 characters. Names are unique across MindCloud.

string

A new description, up to 2048 characters.

string

An abbreviation, not an IANA zone name, so America/New_York is refused and EDT is accepted. One of: ACST, ADT, AEST, AKDT, AST, BST, CAST, CBST, CCST, CDT, CEDT, CPST, CST, CVST, DST, EAST, EDT, EEDT, ESAST, EST, FDT, FST, GDT, GET, GMT, GST, HST, IDT, IST, JDT, JST, KDT, KST, LST, MDT, MEDT, MPST, MSK, MST, NAEST, NAST, NCAST, NDT, NST, NZST, PDT, PKT, PSST, PST, PYT, RDT, SAMT, SAST, SDT, SEST, SLST, SPST, SST, SWST, TDT, TST, U, UCST, UEDT, UMST, UST, UTC, VST, WAST, WCAST, WEDT, WPST, YEKT, YST.

string

An https URL of the logo image, up to 512 characters, or null to remove it.

object

Whether people who sign up with an email at one of the company domains can find and join it.

isEnabledbooleanrequired
true lets people who sign up with an email at a company domain find and join it; false turns that off.

Response fields

idstring

Unique id of the company.

namestring

The company's name.

descriptionstring

The company's description.

timezonestring

The company's timezone key, an abbreviation such as EDT or PST rather than an IANA zone name.

regionstring

Where the company keeps its data: us-west-1 (United States), eu-north-1 (European Union) or sa-east-1 (Brazil).

us-west-1
eu-north-1
sa-east-1

isPersonalboolean

True for personal workspaces rather than team companies.

logostring

The company's logo URL.

parentobject

The parent organization, or null when the company has none. Its API keys can act in this company.

idstring
The parent's company id.
namestring
The parent's name.
originstring
created when the parent created this company, linked when this company accepted the parent.
- created
- linked
linkedOndate
When the link started.

memberCountnumber

Members of the company, including people whose invite is pending.

roleCountnumber

Roles you can assign: the built-in roles plus your custom roles (List Roles).

domainDiscoveryobject

Whether people who sign up with an email at one of these domains can find and join the company.

isEnabledboolean
True when domain discovery is on.
domainsarray
The email domains it applies to.

embeddedobject

MindCloud Embedded for the company.

isEnabledboolean
True when Embedded is enabled, so end users can connect their own accounts.

isDeletedboolean

True after the company was deleted.

createdOndate

When the company was created.

updatedOndate

When it was last changed.