Delete an unsubscribe group

If the group has 0 active suppressions, hard-deletes the row. With force=true, soft-deletes all active suppressions first (status → removed, group_id cleared, removed audit event per block) in a single transaction, then hard-deletes the group. Without force and active suppressions present → 409. Audit trail is preserved. force only accepts the string "true" or boolean true; all other values are false.

DELETE /email_unsubscribe_groups/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.emailUnsubscribeGroups.delete('id');

401

{
  "errors": [
    {
      "code": "10007",
      "title": "Unauthorized",
      "detail": "Missing authentication"
    }
  ]
}

Authorizations

Authorization · string · header · required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

id · string<uuid> · required

Resource UUID. Malformed UUIDs are treated as not-found (not 400).

Query Parameters

force · enum<string> boolean

Force-delete a group with active suppressions. Only "true" (string) or true (bool) are truthy; all other values are false.

Available options: true, false

Response

204

Deleted.