companies

Deletes the specified company.

Changed on

Deletes the specified company using the selected delete operation. Linked projects can be detached, moved to another company, or deleted with related work.

<Check title="Required Permissions" icon="key">The user must be an admin or have company-master-data:write permissions.</Check>

post/companies/{companyId}/delete

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/companies/{companyId}/delete
  • Auth: HTTP bearer

Path parameters

companyIdstring uuid required

The id of the company.

Request body

moveToCompanystring uuid nullable

Moves all related objects to this company. Related projects and tasks (including their time entries) will be connected to this company. Have to set if 'DeleteOperation' contains 'move'.

deleteOperationstring nullable

Defines the operation to delete a company. Possible operations are 'move': Move related objects to another company. 'delete-only-company': Delete only the company. Related objects loose the company information. 'delete-all-without-timeentries': Delete all related objects apart from time entries. 'delete-all': Delete all.

Response

No Content

object required

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostCompanyDeleteByCompanyId removed and replaced with companies_PostCompanyDeleteByCompanyId