# DeleteCompany

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.HubSpot/tree/main/Frends.HubSpot.DeleteCompany>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name          | Description                                                                                                    |
| ------------- | -------------------------------------------------------------------------------------------------------------- |
| Id : `String` | <p>The HubSpot ID of the company to delete.</p><p><br>Default: <code>-</code><br>Example: <code>123</code></p> |
| {% endtab %}  |                                                                                                                |

{% tab title="Parameter: Connection" %}

| Name                | Description                                                                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| 🗝ApiKey : `String` | <p>HubSpot Private App access token.</p><p><br>Default: <code>-</code><br>Example: <code>xxx-xxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code></p> |
| BaseUrl : `String`  | <p>Base Url for the Api.</p><p><br>Default: <code>-</code><br>Example: <code><https://api.hubapi.com></code></p>                                 |
| {% endtab %}        |                                                                                                                                                  |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                    |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p> |
| {% endtab %}                     |                                                                                                                                |

{% tab title="Result: Result" %}

| Name                | Description                                                                                                                    |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean` | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                             |
| Id : `String`       | <p>The ID of the deleted company.<br>Example: <code>1234</code></p>                                                            |
| Error : `Error`     | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p> |
| {% endtab %}        |                                                                                                                                |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2026-04-07

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}