Skip to main content
PUT
Create or update a company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Company external ID

environmentId
string
required

Environment ID

projectId
string
required

Project ID

Body

application/json
attributes
object

Custom attributes to set on the company (merged into existing attributes). Attributes with an unknown codeName AUTO-CREATE a definition (dataType inferred from the value) — a mistyped key silently creates a new attribute instead of updating the real one. Each key must be a valid codeName: start with a letter, then letters/digits/underscores, 2–100 chars.

Response

Company created or updated

id
string
required

External company id — the id your app supplied at group/upsert.

object
enum<string>
required
Available options:
company
attributes
object
required
createdAt
string<date-time>
required
users
object[] | null
required

null = not expanded (pass expand: ["users"]); [] = expanded, none.

memberships
object[] | null
required

null = not expanded (pass expand: ["memberships"]); [] = expanded, none.