Updates a Company

put

https://api.edgeiq.io/api/v1/platform/companies/{id}

Updates a Company

Path Params

string

required

The ID that specifies a Company

Body Params

_id

string

required

The unique identifier of the company. Assigned at creation, uneditable. Must by unique across system. Allowed to contain only lower or uppercase letters, numbers, underscores and dashes (the characters - or _)

company_id

string

The unique identifier of the company which owns this company. For companies with a direct relationship to EdgeIQ this will be machineshop. For company accounts belonging to another company, this will be the owning company's id.

user_id

string

The user id that created the company. Present only for backwards compatibility.

name

string

required

The name of the company

branding

object

Branding information for companies

aliases

object

Aliases to use instead of some common key words

portal_configuration

object

Company configuration of the EdgeIQ portal

metadata

object

This field is a way to store an untyped, key-value, user defined data.

user_ids

array of strings

Ids of users belong to this company

user_ids

view_abilities

object

deprecated

Deprecated. Unused.

Responses

200

Successful operation

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!