---
updatedAt: 2026-09-21T15:30:18.000Z
agentTools:
projectIndex: https://developer.avionte.com/llms.txt
---
# Update a Company
Updates information about the specified company.
When making a PUT request, make sure to include the entire object in the payload for successful updates.
Any value provided for `createdDate` is ignored and does not change the company's creation date.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "BOLD Front Office API",
"description": "Manage BOLD Front Office data",
"license": {
"name": "Avionté Open API License"
},
"version": "1.28.9-r53"
},
"servers": [
{
"url": "https://api.avionte.com/front-office"
}
],
"security": [
{
"api_key": []
},
{
"bearerTokenAuth": []
}
],
"tags": [
{
"name": "Companies"
}
],
"paths": {
"/v1/company": {
"put": {
"tags": [
"Companies"
],
"summary": "Update a Company",
"description": "Updates information about the specified company.",
"operationId": "UpdateCompany",
"parameters": [
{
"name": "RequestId",
"in": "header",
"description": "Unique request identifier (UUID) used to correlate request data with log entries and events.",
"required": false,
"schema": {
"$ref": "#/components/schemas/RequestId"
}
},
{
"name": "FrontOfficeTenantId",
"in": "header",
"description": "An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.",
"required": false,
"schema": {
"type": "integer"
},
"example": 89
},
{
"name": "Tenant",
"in": "header",
"description": "Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.",
"required": false,
"schema": {
"type": "string"
},
"example": "API_TEST"
},
{
"name": "isDuplicateBypassed",
"in": "query",
"description": "An indication of whether to bypass the duplicate company name check when updating a company record. If set to `true`, the duplicate name validation is skipped; if set to `false` or not provided, the validation is applied and the update is rejected if a duplicate name is found.",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The updated company.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyDTO"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
},
"401": {
"$ref": "#/components/responses/401Unauthorized"
},
"403": {
"$ref": "#/components/responses/403AccessDenied"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"405": {
"$ref": "#/components/responses/405UnsupportedMethod"
},
"406": {
"$ref": "#/components/responses/406UnsupportedAccessHeader"
},
"409": {
"$ref": "#/components/responses/409Conflict"
},
"415": {
"$ref": "#/components/responses/415UnsupportedContentType"
},
"429": {
"$ref": "#/components/responses/429TooManyRequests"
},
"500": {
"$ref": "#/components/responses/500InternalError"
},
"502": {
"$ref": "#/components/responses/502BadGateway"
},
"504": {
"$ref": "#/components/responses/504GatewayTimeout"
}
}
}
}
},
"components": {
"schemas": {
"CompanyDTO": {
"required": [
"frontOfficeId",
"name",
"origin"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The identifier for the company.",
"format": "int32",
"example": 12345
},
"name": {
"maxLength": 255,
"type": "string",
"description": "The name of the company.",
"example": "Acme Corporation"
},
"mainAddress": {
"description": "The main address of the company.",
"oneOf": [
{
"$ref": "#/components/schemas/Address"
}
]
},
"frontOfficeId": {
"type": "integer",
"description": "The identifier for the company's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.",
"format": "int32",
"example": 12353
},
"link": {
"maxLength": 255,
"type": "string",
"description": "The website of the company.",
"example": "https://www.acmecorp.com"
},
"isArchived": {
"type": "boolean",
"description": "An indication of whether the company record is archived or not.",
"example": false
},
"representativeUsers": {
"type": "array",
"description": "The IDs of the representatives who are working with the company.",
"example": [
123498,
123499
],
"items": {
"type": "integer",
"format": "int32"
}
},
"sourceName": {
"maxLength": 255,
"type": "string",
"description": "The name of the company source.",
"example": "Indeed"
},
"statusId": {
"type": "integer",
"description": "The identifier for the company status.",
"format": "int32",
"example": 128
},
"status": {
"maxLength": 255,
"type": "string",
"description": "The status of the company. When a new status value is passed, the status is added to the tenant's list of custom company statuses, else we match on the string value to an existing company status.",
"example": "Active"
},
"industry": {
"maxLength": 100,
"type": "string",
"description": "The company industry.",
"example": "Information Technology"
},
"createdDate": {
"type": "string",
"description": "The date the company profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.",
"format": "date-time"
},
"origin": {
"maxLength": 50,
"type": "string",
"description": "The partner or vendor that originated the request.",
"example": "Acme Partner"
},
"originRecordId": {
"maxLength": 255,
"type": "string",
"description": "The identifier for the company that can be used to link the record within the originating system.",
"example": "ACME-12345"
},
"department": {
"description": "The department object for company.",
"oneOf": [
{
"$ref": "#/components/schemas/DepartmentDTO"
}
]
},
"weekEndDay": {
"type": "string",
"description": "The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.",
"example": "Friday"
},
"payPeriod": {
"type": "string",
"description": "The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.",
"example": "Weekly"
},
"payCycle": {
"type": "string",
"description": "The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.",
"example": "1"
},
"billingPeriod": {
"type": "string",
"description": "The Billing Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.",
"example": "BiWeekly"
},
"billingCycle": {
"type": "string",
"description": "The Billing Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.",
"example": "2"
},
"isParent": {
"type": "boolean",
"description": "An indication of whether the company is a parent company.",
"example": true
},
"parentCompanyId": {
"type": "integer",
"description": "The identifier for the parent company if this company is a child.",
"format": "int32",
"example": 13839
},
"phoneNumber": {
"maxLength": 255,
"type": "string",
"description": "The phone number for the company.",
"example": "305-555-01472"
}
},
"additionalProperties": false
},
"DepartmentDTO": {
"required": [
"compId",
"country",
"departmentName",
"stateProvince"
],
"type": "object",
"properties": {
"compId": {
"type": "integer",
"description": "The identifier for company.",
"format": "int32",
"example": 123456
},
"departmentName": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The name of the department.",
"example": "Warehouse"
},
"officeId": {
"type": "integer",
"description": "The identifier for the office.",
"format": "int32",
"example": 789012
},
"statusId": {
"type": "integer",
"description": "The identifier for the status.",
"format": "int32",
"example": 263
},
"parentDepartmentId": {
"type": "integer",
"description": "The identifier for the parent department.",
"format": "int32",
"example": 345678
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "Street address line 1 for the department.",
"example": "123 Main Street"
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "Street address line 2 for the department.",
"example": "Suite 100"
},
"city": {
"maxLength": 255,
"type": "string",
"description": "City for the department.",
"example": "Eagan"
},
"stateProvince": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Province, state, or region for the department.",
"example": "MN"
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "ZIP/postal code for the department.",
"example": "55121"
},
"country": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "A 2-letter ISO 3166-1 alpha-2 code representing the department country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.",
"example": "US"
},
"geoCode": {
"maxLength": 50,
"type": "string",
"description": "Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.",
"example": "241234892"
},
"departmentPhone": {
"maxLength": 255,
"type": "string",
"description": "Phone number of the branch.",
"example": "651-555-1234"
},
"defaultJobOwnerIDs": {
"type": "array",
"description": "User IDs of the default job owners of the department.",
"example": [
12345,
67890
],
"items": {
"type": "integer",
"format": "int32"
}
},
"origin": {
"maxLength": 50,
"type": "string",
"description": "The origin of the department.",
"example": "PartnerXYZ"
},
"weekEndDate": {
"type": "string",
"description": "Week End Date for the department.\nAllowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.",
"example": "Friday"
},
"payPeriod": {
"type": "string",
"description": "Pay Period for the department.\nAllowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.",
"example": "Weekly"
},
"payCycle": {
"type": "string",
"description": "Pay Cycle for the department.\nAllowed values: 1, 2, 3, 4, Last Week.",
"example": "1"
},
"billingPeriod": {
"type": "string",
"description": "Billing Period for the department.\nAllowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.",
"example": "BiWeekly"
},
"billingCycle": {
"type": "string",
"description": "Billing Cycle for the department.\nAllowed values: 1, 2, 3, 4, Last Week.",
"example": "2"
},
"originRecordId": {
"maxLength": 255,
"type": "string",
"description": "The identifier for the origin of the department from partner database.",
"example": "12345-abcde"
}
},
"additionalProperties": false
},
"RequestId": {
"type": "string",
"description": "Unique request identifier in UUID format used to correlate request data to log entries and events.",
"format": "uuid",
"example": "63680b86-c7e0-4a36-ae4a-d0d481089aff"
},
"Address": {
"type": "object",
"properties": {
"street1": {
"maxLength": 255,
"type": "string",
"description": "Street address, line 1.",
"example": "123 Main Street"
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "Street address, line 2.",
"example": "Suite 100"
},
"city": {
"maxLength": 255,
"type": "string",
"description": "City.",
"example": "St. Paul"
},
"state_Province": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "ISO 2-character code for the Province, State, or Region.",
"example": "MN"
},
"postalCode": {
"maxLength": 50,
"type": "string",
"description": "ZIP/postal code.",
"example": "55121"
},
"country": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., \"US\", not \"USA\"). For details, see the General Guidelines.",
"example": "US"
},
"county": {
"maxLength": 255,
"type": "string",
"description": "County.",
"example": "Dakota"
},
"geoCode": {
"maxLength": 50,
"type": "string",
"description": "Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.",
"example": "241231070"
},
"schoolDistrictCode": {
"maxLength": 50,
"type": "string",
"description": "School district code based on the Geo Code.",
"example": "00000"
}
},
"additionalProperties": false
}
},
"responses": {
"400BadRequest": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"401Unauthorized": {
"description": "Unauthorized"
},
"403AccessDenied": {
"description": "Access Denied"
},
"404NotFound": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "string",
"description": "Identifier of the entity not found (can be an integer or UUID)"
}
}
}
}
}
},
"405UnsupportedMethod": {
"description": "Unsupported method"
},
"406UnsupportedAccessHeader": {
"description": "Unsupported format(s) indicated by Accept header"
},
"409Conflict": {
"description": "Operation could not be completed due to conflict."
},
"415UnsupportedContentType": {
"description": "Unsupported format(s) indicated by the Content-Type header"
},
"429TooManyRequests": {
"description": "Too many requests"
},
"500InternalError": {
"description": "An unexpected error occurred"
},
"502BadGateway": {
"description": "Service Unavailable"
},
"504GatewayTimeout": {
"description": "Gateway Timeout"
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
},
"bearerTokenAuth": {
"type": "http",
"description": "Contains the caller's access token, in the form \"Bearer {token}\", without quotes.",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```