Skip to main content
PUT
Offboard Company
This endpoint starts the offboarding process for a company, which is a safer alternative to permanent deletion. Offboarding allows for a controlled wind-down of operations while maintaining data integrity and compliance requirements.

What is Offboarding?

Offboarding is a structured process that:
  • Gracefully transitions the company out of active service
  • Preserves historical data for compliance and reporting
  • Ensures proper closure of ongoing operations
  • Maintains audit trails for business purposes
  • Allows for potential reactivation if needed
Offboarding vs Deletion: Unlike deletion, offboarding preserves all company data while marking the company as no longer active. This approach is recommended for compliance and business continuity.

Path Parameters

string
required
The unique identifier of the company to offboard

Offboarding Process

process
Company status is automatically changed to “Off Boarding”
process
All associated stores are marked for offboarding
Stores may be deactivated or marked as “Off Boarding” depending on configuration
process
System prevents new orders while allowing existing orders to complete
process
Inventory updates are disabled to prevent new stock changes
process
User accounts are disabled or restricted to view-only access
process
Third-party integrations are paused or disconnected safely
process
All historical data, reports, and configurations are preserved

Post-Offboarding Effects

changed
Status automatically set to “Off Boarding”
disabled
All stores become unavailable for new orders
restricted
Most write operations are disabled, read operations may be restricted
hidden
Company and stores are hidden from customer-facing applications
limited
Admin users get read-only access for reporting and data export
adjusted
Billing cycles may be adjusted or terminated based on configuration

Response

boolean
Indicates whether the offboarding process was successfully initiated

Response Example

Reactivation Process

required
Reactivation typically requires manual intervention from support team
process
Business requirements and conditions may need to be reviewed
process
System integrity and data consistency checks are performed
process
Services are restored incrementally to ensure stability

Best Practices

best-practice
Notify all stakeholders before initiating offboarding
Send advance notice to customers, partners, and internal teams
best-practice
Export critical business data before offboarding
Generate reports for sales, inventory, and customer data
best-practice
Allow time for pending orders to complete naturally
Offboarding with pending orders may affect customer experience
best-practice
Complete all financial transactions and settlements
Ensure all payments, refunds, and fees are properly processed
best-practice
Properly disconnect third-party services and integrations
Update webhook URLs and disable API keys to prevent errors

Error Scenarios

error
The specified company_id does not existStatus Code: 404
error
Company is already in “Off Boarding” or “Churned” statusStatus Code: 409
warning
Company has active orders that may be affectedStatus Code: 200 (Success with warning)Note: Process continues but active orders are flagged for attention
error
User lacks permission to offboard companiesStatus Code: 403
Timing Considerations: Plan offboarding during low-activity periods to minimize impact on customers and operations. Consider timezone differences if serving multiple regions.
Compliance: Offboarding maintains compliance with data retention requirements while safely removing companies from active service. This approach is preferred over deletion for regulated industries.