Skip to main content

companyDelete

Permanently delete a company from the system.

Removes the company and all associated data. This action cannot be undone. All related contacts, relationships, and configurations will also be removed.

Possible errors:

  • COMPANY_NOT_FOUND_ERROR: Company with the specified ID does not exist
  • COMPANY_DELETE_ERROR: Failed to delete the company

AUTH: Role=[user.OWNER]

companyDelete(
  id: Int!
): String!

Arguments​

companyDelete.id ● Int! non-null scalar​

Unique identifier of the company to delete.

Must be a positive integer representing a valid company ID in the system.

Type​

String scalar​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.