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.

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

name · string

Updated company name. Example: “Salman’s Company New”

email · string

Updated company contact email address. Example: “[e-mail]”

address · object

Updated company address information

Show address

line_1 · string

Updated primary address line. Example: “39 Block Q, Phase 2 Johar Town”

city · string

Updated city name. Example: “Lahore”

state · string

Updated state or province. Example: “Punjab”

zip · string

Updated ZIP or postal code. Example: “54782”

phone_number · string

Updated company contact phone number. Example: “090078601”

website · string

Updated company website URL. Example: “https://www.lulaconvenience.com/“

Note the correct spelling is “website” not “webiste”

logo · string

Updated company logo URL or base64 encoded image

banner · string

Updated company banner image URL or base64 encoded image

profile_image · string

Updated company profile image URL or base64 encoded image

receipt_header · string

Updated custom header text for receipts

ein · string

Updated Employer Identification Number. Example: “0000”

status · string

Updated company operational status. Example: “Churned”

Valid Status Values

• On Boarding
• Live
• Off Boarding
• Churned
• Suspended

Changing status to “Churned” or “Suspended” may affect store operations

company_type · string

Updated type of company classification. Example: “Mid-Market”

Valid Company Types

• Enterprise
• Mid-Market
• Small Business
• Startup

active · number

Updated company active status. Use 1 for active, 0 for inactive

Setting to 0 will deactivate the company and all associated stores

hubspot_id · number

Updated HubSpot contact ID for CRM integration. Example: 12121212121212

Path Parameters

company_id · string · required

The unique identifier of the company to update

Request Example

{
    "name": "Salman's Company New",
    "email": "[e-mail]",
    "address": {
        "line_1": "39 Block Q, Phase 2 Johar Town",
        "city": "Lahore",
        "state": "Punjab",
        "zip": "54782"
    },
    "phone_number": "090078601",
    "website": "https://www.lulaconvenience.com/",
    "logo": "",
    "banner": "",
    "profile_image": "",
    "receipt_header": "",
    "ein": "0000",
    "status": "Churned",
    "company_type": "Mid-Market",
    "active": 1,
    "hubspot_id": 12121212121212
}

Response

success · boolean

Indicates whether the update operation was successful

Response Example

{
    "success": true
}

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.