Add or Update Company
post
[PlatformAddress]/api/1.0/contact?action=addOrUpdateCompany
Add or Update Company

Example Request: Adding a company

1
{
2
"businessName": "New Company",
3
"tradingName": "ABC",
4
"email": "[email protected]",
5
"address": {
6
"line1": "address line 1",
7
"line2": "address line 2",
8
"stateCode": "QLD",
9
"postalCode": "4227",
10
"countryCode": "AU"
11
},
12
"primaryAccountManagerId": 123,
13
"secondaryAccountManagerId": 123,
14
"industryId": 11,
15
"isAgent": 1,
16
"commissionSpace": 20,
17
"commissionSpaceType" : 2,
18
"commissionFoodType": "2",
19
"commissionFood":"10",
20
"commissionBeverage": 30,
21
"commissionBeverageType" : 1,
22
"commissionAudioVisual": 50,
23
"commissionAudioVisualType" : 2,
24
"commissionAccommodation": 50,
25
"commissionAccommodationType": 1,
26
"iataNumber": "123456789",
27
"customFields": [
28
{
29
"fieldId": 6,
30
"value": "2022-08-30 10:00:00 UTC"
31
},
32
{
33
"fieldId": 7,
34
"value": "string"
35
}
36
]
37
}
Copied!

Example Request: Updating a Company

1
{
2
"id": 1618,
3
"businessName": "Updated Company name",
4
"address": {
5
"line1": "address line 11",
6
"line2": "address line 22",
7
"stateCode": "QLD",
8
"postalCode": "4227",
9
"countryCode": "AU"
10
}
11
"primaryAccountManagerId": 123,
12
"secondaryAccountManagerId": 123,
13
"industryId": 11,
14
"isAgent": 1,
15
"commissionSpace": 20,
16
"commissionSpaceType" : 2,
17
"commissionFoodType": "2",
18
"commissionFood":"10",
19
"commissionBeverage": 30,
20
"commissionBeverageType" : 1,
21
"commissionAudioVisual": 50,
22
"commissionAudioVisualType" : 2,
23
"commissionAccommodation": 50,
24
"commissionAccommodationType": 1,
25
"iataNumber": "123456789",
26
"customFields": [
27
{
28
"fieldId": 6,
29
"value": "2022-08-30 10:00:00 UTC"
30
},
31
{
32
"fieldId": 7,
33
"value": "string"
34
}
35
]
36
}
Copied!

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. 1.
    Updates the values for that company (after you have provided an id in the parameters), or
  2. 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