Creating and updating a company from the API can be done by posting your company object to Supportbench.
The only difference between company creations and updates is including a company id within the company object.
When creating or updating a company, the below fields are available to you.
Name | Required | Limit | Default | Availability | Summary |
|---|---|---|---|---|---|
id_prefix | no | 5 characters | "CP" | New | The prefix of the company. You can assign new company prefix's within the API administration section. |
id_source | no | 25 characters | New | The source id of the company. You can assign custom ID's from existing systems or assign your own id. | |
id | no - when creating | 30 characters | Update | The full company id including the prefix. | |
name | yes | 500 characters | New / Update | The company name. | |
address | no | 250 characters | New / Update | The mailing address of the company. | |
city | no | 100 characters | New / Update | The mailing city of the company. | |
zip | no | 25 characters | New / Update | The mailing zip / postal code of the company. | |
state | no | 50 characters | New / Update | The mailing state or province of the company. | |
country | no | 5 characters | New / Update | The 2 character ISO country code of the company. i.e. US, CA. Country code can be found here: https://countrycode.org/ | |
support_level_id | no | Integer | New / Update | The support level id of the company. | |
active | no | Boolean | New / Update | Is the company active or not. | |
fields | no | See field object | New / Update | A field array of custom fields to insert or update. Please see the field object below. |
Fields Object
Name | Required | Limit | Default | Summary |
|---|---|---|---|---|
id | yes | Integer | The field id of the field you wish to update. The field id must map to a valid field in the company. | |
value | yes | Dropdown list - Integer | The value of the custom field. The value is dependent on the field type. |