Company

Create or update a company

Changed on

Create or update a company by its external companyId (upsert). Only name, plan, domain, value, sla, tags, address, customData and the account owner (owner or ownerEmail) are accepted; any other field is ignored. tags REPLACES the stored list (an empty array clears it), while address and customData are merged into the existing values rather than replaced. customData accepts up to 100 primitive values, tags up to 50. Setting a non-empty name here marks it authoritative, so names sent by the SDK will no longer overwrite it. owner is the id of a user in this project (ownerEmail their email address); null or "" clears it. An owner that is not a project member's id or email is ignored (the rest of the update still applies), so check owner in the response.

put/companies/{companyId}

Request

  • Base URL
    https://api.gleap.io/v3
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

Headers

projectstring required

Request body

nameunknown
planunknown
domainunknown
valueunknown
slaunknown
tagsunknown
addressunknown
customDataunknown
ownerunknown
ownerEmailunknown

Example request

{
  "name": "Bäckerei Huber GmbH",
  "plan": "Kplus Premium",
  "domain": "baeckerei-huber.at",
  "value": 4800,
  "tags": [
    "vip"
  ],
  "address": {
    "city": "Innsbruck",
    "country": "AT"
  },
  "customData": {
    "licenseNumber": "LIZ-10442",
    "modules": [
      "Kassa",
      "DMS"
    ]
  },
  "ownerEmail": "support@example.com"
}

Response

Ok

_idstring required
companyIdstring required
namestring
planstring
domainstring
valuenumber double
slanumber double
tagsstring[]
customDataobject
ownerstring
ownerEmailstring
nameIsAuthoritativeboolean
lastSeenAtstring
createdAtstring
updatedAtstring

Changes

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from array to no type

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed subschema #1 subschema #2 subschema #4 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status