Updates the company with the specified id. | awork API

import requests
url = "https://api.awork.com/api/v1/companies/companyId"
payload = { "name": "NCNSTN Brand Design" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "name": "NCNSTN Brand Design",
  "description": "A small agency with a team of around 20 people, located in the heart of Berlin",
  "industry": "Brand Agency",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "hasImage": true,
  "companyContactInfos": [
    {
      "type": "address",
      "label": "Headquarters",
      "value": "Torstrasse 140, Hof A, 10119 Berlin",
      "subType": "central",
      "addressLine1": "Torstrasse 140",
      "addressLine2": "Hof A",
      "zipCode": "10119",
      "city": "Berlin",
      "state": "Berlin",
      "country": "DE",
      "isAddress": true,
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "createdOn": "2024-01-15T09:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174002",
      "updatedOn": "2024-04-10T11:45:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174003"
    }
  ],
  "createdOn": "2023-12-01T08:00:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174004",
  "updatedOn": "2024-04-10T11:45:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174003",
  "resourceVersion": 637825154598057900,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174005",
      "name": "Design",
      "color": "purple"
    }
  ],
  "projectsCount": 3,
  "projectsInProgressCount": 2,
  "isExternal": true
}

Required Permissions

The user must be an admin or have company-master-data:write permissions.

<Check title="Required Permissions" icon="key">The user must be an admin or have `company-master-data:write` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequiredformat: "uuid"

The id of the company to update.

Request

The model with updated company data.

namestringRequired0-1000 characters

The company name.

descriptionstring or nullOptional0-25000 characters

The company description.

industrystring or nullOptional0-1000 characters

The company's industry.

Response

namestring0-1000 characters

The company name.

descriptionstring or null0-25000 characters

The company description.

industrystring or null0-1000 characters

The company's industry.

idstringformat: "uuid"

The id of the company.

hasImageboolean

Whether the company has an image.

companyContactInfoslist of objects or null

The company infos assigned to this company.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

resourceVersionlongRead-only

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

tagslist of objects or null

The tags for this company.

projectsCountinteger

The number of all projects related to the company.

projectsInProgressCountinteger

The number of all projects in status 'progress' related to the company.

isExternalboolean

True if this entity is coming from an external workspace (awork Connect).

Errors

400

Bad Request Error