SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceCompanies

Updates the contact info for the company with the specified id.

PUT
https://api.awork.com/api/v1/companies/:companyId/contactinfo/:contactInfoId
PUT
/api/v1/companies/:companyId/contactinfo/:contactInfoId
1curl -X PUT https://api.awork.com/api/v1/companies/companyId/contactinfo/contactInfoId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "type": "address"
6}'
Try it
200Updated
1{
2  "type": "address",
3  "label": "string",
4  "value": "string",
5  "subType": "central",
6  "addressLine1": "Torstrasse 140",
7  "addressLine2": "Hof A",
8  "zipCode": "10119",
9  "city": "Berlin",
10  "state": "string",
11  "country": "DE",
12  "isAddress": true,
13  "id": "123e4567-e89b-12d3-a456-426614174000",
14  "createdOn": "2024-01-15T09:30:00Z",
15  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
16  "updatedOn": "2024-01-15T09:30:00Z",
17  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
18}
<Check title="Required Permissions">The user must be an admin or have `company-master-data:write` permissions.</Check>
Was this page helpful?
Previous

Deletes the contact info of the company with the specified id.

Next
Built with
Deletes the contact info of the company with the specified id.

Authentication

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

Path parameters

companyIdstringRequiredformat: "uuid"
The id of the company.
contactInfoIdstringRequiredformat: "uuid"
The id of the contactInfo.

Request

The contact info to update.
The id of the company.
The id of the contactInfo.

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

The contact info to update.
typestringRequired>=0 characters<=25 characters
The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'.
labelstring or nullOptional>=0 characters<=1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or nullOptional>=0 characters<=1000 characters
The value of the contact info.
subTypestring or nullOptional>=0 characters<=25 characters
The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other']
addressLine1string or nullOptional>=0 characters<=1000 characters
The first address line of the contact info.
addressLine2string or nullOptional>=0 characters<=100 characters
The second address line of the contact info.
zipCodestring or nullOptional>=0 characters<=100 characters
The zipcode of the contact info.
citystring or nullOptional>=0 characters<=100 characters
The city of the contact info.
statestring or nullOptional>=0 characters<=100 characters
The state of the contact info.
countrystring or nullOptional>=0 characters<=100 characters
The 2 letter iso code of the country.
isAddressbooleanOptional
Flags whether this contact info is an address. If it's an address, the address fields are required.

Response

OK
typestring>=0 characters<=25 characters
The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'.
labelstring or null>=0 characters<=1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or null>=0 characters<=1000 characters
The value of the contact info.
subTypestring or null>=0 characters<=25 characters
The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other']
addressLine1string or null>=0 characters<=1000 characters
The first address line of the contact info.
addressLine2string or null>=0 characters<=100 characters
The second address line of the contact info.
zipCodestring or null>=0 characters<=100 characters
The zipcode of the contact info.
citystring or null>=0 characters<=100 characters
The city of the contact info.
statestring or null>=0 characters<=100 characters
The state of the contact info.
countrystring or null>=0 characters<=100 characters
The 2 letter iso code of the country.
isAddressboolean or null
Flags whether this contact info is an address. If it's an address, the address fields are required.
idstring or nullformat: "uuid"
The Id of the contact info.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
Required Permissions
The user must be an admin or have company-master-data:write permissions.

The type of the contact info. Possible values are: ‘phone’, ‘email’, ‘address’, ‘custom’.

The type of the contact info. Possible values are: ‘phone’, ‘email’, ‘address’, ‘custom’.

The subtype of the contact info, Possible values are: phone: [ ‘central’, ‘other’ ] email: [ ‘central’, ‘invoice’, ‘other’ ] address: [ ‘central’, ‘invoice’, ‘other’ ] url: [ ‘primary’, ‘other’]

The subtype of the contact info, Possible values are: phone: [ ‘central’, ‘other’ ] email: [ ‘central’, ‘invoice’, ‘other’ ] address: [ ‘central’, ‘invoice’, ‘other’ ] url: [ ‘primary’, ‘other’]