Updates the company with the specified id.

PUT

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

Path parameters

companyIdstringRequired

The id of the company.

Request

This endpoint expects an object.

namestringRequired>=0 characters<=1000 characters

The company name.

descriptionstringOptional>=0 characters<=25000 characters

The company description.

industrystringOptional>=0 characters<=1000 characters

The company’s industry.

Response

namestring>=0 characters<=1000 characters

The company name.

descriptionstringOptional>=0 characters<=25000 characters

The company description.

industrystringOptional>=0 characters<=1000 characters

The company’s industry.

idstringOptional

The id of the company.

hasImagebooleanOptionalDefaults to false

Whether the company has an image.

companyContactInfoslist of objectsOptional

The company infos assigned to this company.

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this entity was created.

createdBystringOptional

The id of the user who created this entity.

updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this entity was last modified.

updatedBystringOptional

The id of the user who last modified this entity.

resourceVersionlongOptionalDefaults to 0

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

tagslist of objectsOptional

The tags for this company.

projectsCountintegerOptional

The number of all projects related to the company.

projectsInProgressCountintegerOptional

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

isExternalbooleanOptionalDefaults to false

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

PUT

1 curl -X PUT https://api.awork.com/api/v1/companies/companyId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "NCNSTN Brand Design"
6 }'

200Updated

1 {
2   "name": "NCNSTN Brand Design",
3   "description": "A small agency with a team of around 20 people, located in the heart of Berlin",
4   "industry": "Brand Agency",
5   "id": "123e4567-e89b-12d3-a456-426614174000",
6   "hasImage": true,
7   "companyContactInfos": [
8     {
9       "type": "address",
10       "label": "label",
11       "value": "value",
12       "subType": "central",
13       "addressLine1": "Torstrasse 140",
14       "addressLine2": "Hof A",
15       "zipCode": "10119",
16       "city": "Berlin",
17       "state": "state",
18       "country": "DE",
19       "isAddress": true,
20       "id": "123e4567-e89b-12d3-a456-426614174000",
21       "createdOn": "2024-01-15T09:30:00Z",
22       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
23       "updatedOn": "2024-01-15T09:30:00Z",
24       "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
25     }
26   ],
27   "createdOn": "2024-01-15T09:30:00Z",
28   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
29   "updatedOn": "2024-01-15T09:30:00Z",
30   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
31   "resourceVersion": 637825154598057900,
32   "tags": [
33     {
34       "id": "123e4567-e89b-12d3-a456-426614174000",
35       "name": "Design",
36       "color": "purple"
37     }
38   ],
39   "projectsCount": 3,
40   "projectsInProgressCount": 2,
41   "isExternal": true
42 }

Built with

1	curl -X PUT https://api.awork.com/api/v1/companies/companyId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "NCNSTN Brand Design"
6	}'

1	{
2	"name": "NCNSTN Brand Design",
3	"description": "A small agency with a team of around 20 people, located in the heart of Berlin",
4	"industry": "Brand Agency",
5	"id": "123e4567-e89b-12d3-a456-426614174000",
6	"hasImage": true,
7	"companyContactInfos": [
8	{
9	"type": "address",
10	"label": "label",
11	"value": "value",
12	"subType": "central",
13	"addressLine1": "Torstrasse 140",
14	"addressLine2": "Hof A",
15	"zipCode": "10119",
16	"city": "Berlin",
17	"state": "state",
18	"country": "DE",
19	"isAddress": true,
20	"id": "123e4567-e89b-12d3-a456-426614174000",
21	"createdOn": "2024-01-15T09:30:00Z",
22	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
23	"updatedOn": "2024-01-15T09:30:00Z",
24	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
25	}
26	],
27	"createdOn": "2024-01-15T09:30:00Z",
28	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
29	"updatedOn": "2024-01-15T09:30:00Z",
30	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
31	"resourceVersion": 637825154598057900,
32	"tags": [
33	{
34	"id": "123e4567-e89b-12d3-a456-426614174000",
35	"name": "Design",
36	"color": "purple"
37	}
38	],
39	"projectsCount": 3,
40	"projectsInProgressCount": 2,
41	"isExternal": true
42	}