API v1 ReferenceCompanies

Creates a new contact info for the company with the specified id.

Creates a new contact info for the company with the specified id.

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

Path parameters

companyIdUUIDRequired
The id of the company.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
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 or null>=0 characters<=1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or null or null>=0 characters<=1000 characters
The value of the contact info.
subTypestring or null 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 or null>=0 characters<=1000 characters
The first address line of the contact info.
addressLine2string or null or null>=0 characters<=100 characters
The second address line of the contact info.
zipCodestring or null or null>=0 characters<=100 characters
The zipcode of the contact info.
citystring or null or null>=0 characters<=100 characters
The city of the contact info.
statestring or null or null>=0 characters<=100 characters
The state of the contact info.
countrystring or null 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.
idUUID or null
The Id of the contact info.
createdOndatetime or null
The date this entity was created.
createdByUUID or null
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedByUUID or null
The id of the user who last modified this entity.