Skip to main content
POST
Create or update a company.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Company data

Request body for creating or updating a company

name
string
required

Company name

id
string

Company ID (omit for new company)

organizationId
string

Organization to create the company in; it is billed to that organization and counts against its company limit. You must be a member. Ignored on update — omit to use your account organization.

description
string

Company description

website
string

Company website URL

industry
string

Industry type

size
string

Company size

location
string

Company location

logoUrl
string

Company logo URL. Use the Images API to generate a logo and get a URL.

apps
object[]

Company-configured custom apps shown in the side menu. Each entry: {id, name, icon, enabled, openInNewTab?, url?, appId?}. url embeds an external site (iframe, or new tab when openInNewTab); appId references a Public builder app shared into the company.

Response

Company saved successfully

Success response

msg
string

Success message