Delete a contact book
Delete a contact book and every contact in it.
DELETE
https://app.usenotix.dev/api/v1/contactBooks/{contactBookId}Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Delete a contact book and every contact in it. Refused with 400 while a scheduled or running campaign or an active journey uses the book.
Path parameters
contactBookIdstringrequired
Headers
Authorizationstringrequired
Bearer followed by your API key.
Errors
403
Forbidden - API key doesn't have access
404
Contact book not found
Every error has the same shape. See all error codes.
curl -X DELETE "https://app.usenotix.dev/api/v1/contactBooks/<contactBookId>" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.contactBooks.delete("cb_123");
from notix import Notix
notix = Notix() # reads NOTIX_API_KEY
result, _ = notix.contact_books.delete("cb_123")
use Notix\Notix;
$notix = new Notix(getenv('NOTIX_API_KEY'));
$result = $notix->contactBooks->delete('cb_123');
Response200
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"success": true,
"message": "string"
}