Skip to navigation
API v1 ReferenceCompanies

Updates company contact information.

Updates the specified company contact information and refreshes the company’s address data when needed. The contact information must belong to the specified company.

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

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 contact info.

Request

The updated contact info data.
typestringRequired0-25 characters

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

labelstring or nullOptional0-1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or nullOptional0-1000 characters
The value of the contact info.
subTypestring or nullOptional0-25 characters

The subtype of the contact info. Required for all types except ‘custom’. Possible values are: phone: [ ‘central’, ‘other’ ] email: [ ‘central’, ‘invoice’, ‘other’ ] address: [ ‘central’, ‘invoice’, ‘other’ ] url: [ ‘primary’, ‘other’ ]

addressLine1string or nullOptional0-1000 characters
The first address line of the contact info.
addressLine2string or nullOptional0-100 characters
The second address line of the contact info.
zipCodestring or nullOptional0-100 characters
The zipcode of the contact info.
citystring or nullOptional0-100 characters
The city of the contact info.
statestring or nullOptional0-100 characters
The state of the contact info.
countrystring or nullOptional0-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
typestring0-25 characters

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

labelstring or nullOptional0-1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or nullOptional0-1000 characters
The value of the contact info.
subTypestring or nullOptional0-25 characters

The subtype of the contact info. Required for all types except ‘custom’. Possible values are: phone: [ ‘central’, ‘other’ ] email: [ ‘central’, ‘invoice’, ‘other’ ] address: [ ‘central’, ‘invoice’, ‘other’ ] url: [ ‘primary’, ‘other’ ]

addressLine1string or nullOptional0-1000 characters
The first address line of the contact info.
addressLine2string or nullOptional0-100 characters
The second address line of the contact info.
zipCodestring or nullOptional0-100 characters
The zipcode of the contact info.
citystring or nullOptional0-100 characters
The city of the contact info.
statestring or nullOptional0-100 characters
The state of the contact info.
countrystring or nullOptional0-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.
idstringOptionalformat: "uuid"
The Id of the contact info.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.

Errors

400
Bad Request Error
404
Not Found Error