Skip to main content
Activates or deactivates a company record by updating its is_actived status. Validates that the record exists before attempting activation/deactivation. Provides a dedicated endpoint for toggling activation status.

Endpoint

Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header. Permission Required: company:active

Path Parameters

Request Body

Response

Success Response (200 OK)

Returns the updated company record with the new activation status.

Error Responses

400 Bad Request - Invalid request body or validation failed
401 Unauthorized - Missing or invalid authentication token 403 Forbidden - Insufficient permissions 404 Not Found - Record not found

Notes

  • This endpoint is specifically designed for toggling the activation status of a company record.
  • The is_actived field cannot be updated using the standard update endpoint (PATCH /api/v3/product/company/{documentId}).
  • Deactivated records (is_actived = false) may be excluded from certain queries depending on your business logic.
  • The record must exist and be accessible before activation/deactivation can occur.

Examples

Activate a Company

Deactivate a Company