Company

Update a company's Name/Logo/Description/ExternalId. Domains are managed via the domain endpoints below.

put/api/v1/company

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Headers

Loop-Workspace-Idstring
Authorizationstring
X-Impersonate-Userstring

Request body

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
domainsstring[]

0-n email domains owned by this Company. A domain belongs to exactly one Company per workspace.

logostring

Manually uploaded logo link. No third-party favicon resolution in v1.

descriptionstring

Free-text description.

externalIdstring

External CRM/ERP id. Unique within the workspace if set.

profileCountinteger

Number of workspace profiles linked to this Company that the caller can see. Only populated when requested with ?with=profileCount on a single-company get; read-only, ignored on create/update.

Response

OK

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
domainsstring[]

0-n email domains owned by this Company. A domain belongs to exactly one Company per workspace.

logostring

Manually uploaded logo link. No third-party favicon resolution in v1.

descriptionstring

Free-text description.

externalIdstring

External CRM/ERP id. Unique within the workspace if set.

profileCountinteger

Number of workspace profiles linked to this Company that the caller can see. Only populated when requested with ?with=profileCount on a single-company get; read-only, ignored on create/update.

Changes

No recorded changes to this operation across all 1 revision of this API.