Documentation/Delete ContactGroup

Delete ContactGroup

delete/v1/contactGroups/delete

This API allows you to delete a contact group based on the contact group ID you provide.

Code snippet

curl -X 'DELETE' \
  'https://api.boldsign.com/v1/contactGroups/delete?groupId=1b18b34d-aaae-4df8-aa8f-a93cda34379ac_pgVgo' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "API-KEY");

var groupContactClient = new GroupContactClient(apiClient);

groupContactClient.DeleteGroupContactAsync("1b18b34d-aaae-4df8-aa8f-a93cda34379ac_pgVgo");
import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    group_contacts_api = boldsign.GroupContactsApi(api_client)
    group_contact = group_contacts_api.delete_group_contact(
        group_id="YOUR_GROUP_ID"
    )
<?php
require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$apiInstance = new BoldSign\Api\GroupContactsApi($config);
$apiInstance->deleteGroupContact("YOUR_GROUP_ID");
import { GroupContactsApi } from "boldsign";

const contactGroupApi = new GroupContactsApi();
contactGroupApi.setApiKey("YOUR_API_KEY");

contactGroupApi.deleteGroupContact("YOUR_GROUP_ID");
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");

GroupContactsApi groupContactApi = new GroupContactsApi(apiClient);
groupContactApi.deleteGroupContact("YOUR_GROUP_ID");

Query parameters

idstringRequiredThe ID of the contactgroup to delete.

Example response

204 No Content