companies

Upsert company

Changed on
post/companies

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/companies
  • Auth
    API key in header X-Schematic-Api-Key

Request body

base_plan_idstring nullable

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 nullable

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 nullable

If you know the Schematic ID, you can use that here instead of keys

keysobject required

See Key Management for more information

last_seen_atstring date-time nullable
namestring nullable
prevent_key_remapboolean nullable
remove_keysstring[]

Names of keys to remove from the company. Removing a key the company does not have does nothing, and a company must keep at least one key.

traitsobject

A map of trait names to trait values

update_onlyboolean nullable

Response

OK

paramsobject required

Input parameters

Changes

  • 6d4b96940aadRevision changes
    • info

      added the optional property /// to the response with the status

  • ce7c5cc627adRevision changes
    • warning

      added the new end_date_must_be_future enum value to the ///// response property for the response status

    • warning

      added the new end_date_needs_new_subscription enum value to the ///// response property for the response status

    • warning

      added the new end_date_not_after_renewal_date enum value to the ///// response property for the response status