Companies

Upsert company

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
keysmap from strings to stringsRequired

See Key Management for more information

base_plan_idstring or nullOptional

Assign this base plan when creating the company (starts with plan_). Takes precedence over the environment’s initial plan and must be provisionable without a payment method.

base_plan_price_idstring or nullOptional

The Schematic price to provision for base_plan_id (starts with bilpp_). Required and must be $0 for a billing-linked plan; omit for a plan that is not billing-linked.

idstring or nullOptional
If you know the Schematic ID, you can use that here instead of keys
last_seen_atdatetime or nullOptional
namestring or nullOptional<=256 characters
prevent_key_remapboolean or nullOptional
traitsobjectOptional
A map of trait names to trait values
update_onlyboolean or nullOptional

Response

OK
dataobject
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error