Add or Update Company

Add or Update Company

POST [PlatformAddress]/api/1.0/contact?action=addOrUpdateCompany

Add or update company details

Path Parameters

Name	Type	Description
id	integer	The company's identifier. (Leave empty to add the company to the system)
externalId	string	Optionally a unique identifier of the company that is managed by an external application
businessName	string	The company's business name. (Mandatory if adding a new company)
tradingName	string	The company's trading name
businessNumber	string	The company's registration number
phone	string	The company's phone number
otherPhone	string	The company's other phone number
fax	string	The company's fax number
website	string	The company's website
email	string	The company's email address
address	string	The company's address.
primaryContactId	integer	The unique id of the contact to assign as primary contact to the company
primaryContact	object	The data array of contact to assign as primary contact. See addOrUpdateContact API in contact namespace for parameters.
primaryAccountManagerId	integer	The id of primary account manager of the company
secondaryAccountManagerId	integer	The id of secondary account manager of the company
industryId	integer	The industry id of company
isAgent	integer	Whether the company has an agent or not.
commissionSpace	integer	The commission amount of the company for Space.
commissionSpaceType	integer	The commission amount type of the company for Space.
commissionFood	integer	The commission amount of the company for food.
commissionFoodType	integer	The commission amount type of the company for food.
commissionBeverage	integer	The commission amount of the company for beverage.
commissionBeverageType	integer	The commission amount type of the company for beverage.
commissionAudioVisual	integer	The commission amount of the company for audio visual.
commissionAudioVisualType	integer	The commission amount type of the company for audio visual.
commissionAccommodation	integer	The commission amount of the company for accommodation.
commissionAccommodationType	integer	The commission amount type of the company for accommodation.
iataNumber	string	The IATA number of commission payable to the agent.
updateIfExists	boolean	Whether or not to update the company by businessName when id parameter is missing.
customFields	array	The Company Custom fields
externalUrls	array	The Company External URLs

200

Adding a company
{
  "success": true,
  "id": 1618
}

Updating a company
{
  "id": 1618
}

Example Request: Adding a company

{
  "businessName": "New Company",
  "tradingName": "ABC",
  "email": "[e-mail]",
  "address": {
    "line1": "address line 1",
    "line2": "address line 2",
    "stateCode": "QLD",
    "postalCode": "4227",
    "countryCode": "AU"
  },
  "primaryAccountManagerId": 123,
  "secondaryAccountManagerId": 123,
  "industryId": 11,
  "isAgent": 1,
  "commissionSpace": 20,
  "commissionSpaceType" : 2,
  "commissionFoodType": "2",
  "commissionFood":"10",
  "commissionBeverage": 30,
  "commissionBeverageType" : 1,
  "commissionAudioVisual": 50,
  "commissionAudioVisualType" : 2,
  "commissionAccommodation": 50,
  "commissionAccommodationType": 1,
  "iataNumber": "123456789",
  "customFields": [
        {
            "fieldId": 6,
            "value": "2022-08-30 10:00:00 UTC"
        },
        {
            "fieldId": 7,
            "value": "string"
        }
  ],
  "externalUrls" : [
        {
            "ref": "example1",
            "label": "Example One",
            "url": "https://example1.com"
        },
        {
            "ref": "example2",
            "label": "Example Two",
            "url": "https://example2.com"
        },
        {
            "ref": "example3",
            "label": "Example Three",
            "url": "https://example3.com"
        }
    ]
}

Example Request: Updating a Company

{
  "id": 1618,
  "businessName": "Updated Company name",
  "address": {
    "line1": "address line 11",
    "line2": "address line 22",
    "stateCode": "QLD",
    "postalCode": "4227",
    "countryCode": "AU"
  }
  "primaryAccountManagerId": 123,
  "secondaryAccountManagerId": 123,
  "industryId": 11,
  "isAgent": 1,
  "commissionSpace": 20,
  "commissionSpaceType" : 2,
  "commissionFoodType": "2",
  "commissionFood":"10",
  "commissionBeverage": 30,
  "commissionBeverageType" : 1,
  "commissionAudioVisual": 50,
  "commissionAudioVisualType" : 2,
  "commissionAccommodation": 50,
  "commissionAccommodationType": 1,
  "iataNumber": "123456789",
  "customFields": [
        {
            "fieldId": 6,
            "value": "2022-08-30 10:00:00 UTC"
        },
        {
            "fieldId": 7,
            "value": "string"
        }
  ]
}

Keys

keys
line1
line2
line3
line4
city
stateCode (e.g: QLD)
countryCode (e.g: AU)
postalCode

Returns

Property	Description
success	If the company was successfully added or updated
id	The unique identifier for the company
message	Message of the failure (if success was false)

This call takes values for a company, and either

1. Updates the values for that company (after you have provided an id in the parameters), or

2. Adds the company to the system (if the id parameter is missing)

The result of this call will contain the status of the result (either true or false) and the company identifier of the updated or newly created company.

The properties of the company currently supported are:

• businessName

• externalId

• tradingName

• businessNumber

• phone

• fax

• website

• email

• address

  • This is an object

• primaryAccountManagerId

• secondaryAccountManagerId

• industryId

• isAgent

• commissionSpace

• commissionSpaceType

• commissionFoodType,

• commissionFood

• commissionBeverage

• commissionBeverageType

• commissionAudioVisual

• commissionAudioVisualType

• commissionAccommodation

• commissionAccommodationType

• iataNumber

• customFields