Update Company
Companies
Update Company
This endpoint updates an existing company’s information in the system. You can modify any company details including business information, contact details, address, and operational status. All fields are optional - only provide the fields you want to update.
PUT
Update Company
This endpoint allows you to update any aspect of a company’s information. You only need to include the fields you want to modify in the request body. The system will update only the provided fields while keeping other information unchanged.
Request Body Fields
Request Body Fields
Updated company name. Example: “Salman’s Company New”
Updated company contact email address. Example: “[email protected]”
Updated company address information
Updated company contact phone number. Example: “090078601”
Updated company website URL. Example: “https://www.lulaconvenience.com/“
Note the correct spelling is “website” not “webiste”
Updated company logo URL or base64 encoded image
Updated company banner image URL or base64 encoded image
Updated company profile image URL or base64 encoded image
Updated custom header text for receipts
Updated Employer Identification Number. Example: “0000”
Updated company operational status. Example: “Churned”
Valid Status Values
Valid Status Values
- On Boarding
- Live
- Off Boarding
- Churned
- Suspended
Changing status to “Churned” or “Suspended” may affect store operations
Updated type of company classification. Example: “Mid-Market”
Valid Company Types
Valid Company Types
- Enterprise
- Mid-Market
- Small Business
- Startup
Updated company active status. Use 1 for active, 0 for inactive
Setting to 0 will deactivate the company and all associated stores
Updated HubSpot contact ID for CRM integration. Example: 12121212121212
Path Parameters
The unique identifier of the company to update
Request Example
Response
Indicates whether the update operation was successful
Response Example
Partial Updates: You can update individual fields without affecting others. For example, to only update the company name, send just
{"name": "New Company Name"}.Address Updates: When updating address information, you can update individual address fields without providing the complete address object.
Status Changes: Be careful when changing company status, as it may affect:
- Store operations and availability
- Order processing capabilities
- Integration with third-party services
- Billing and subscription status
Validation: The system will validate all provided fields according to the same rules used during company creation. Invalid data will result in an error response.