API v1 ReferenceCompanies

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

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

Path parameters

companyIdstringRequiredformat: "uuid"
The id of the company.

Headers

AuthorizationstringRequired

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

Request

The contact info to create.
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.