Delete a preference profile

DELETE /api/PreferenceProfiles/{id}

Authentication

Send your private API key in the X-Api-Key header. Keep it on your server.

This request can change account configuration or stored data. Review the example values before running it.

Request example

Examples use illustrative values. Set FERRETLY_API_KEY in your server environment for JavaScript, Python, and C#. Replace sample IDs, URLs, and profile values before use.

curl --fail -sS -X DELETE "https://api.ferretly.com/api/PreferenceProfiles/11111111-1111-4111-8111-111111111111" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch("https://api.ferretly.com/api/PreferenceProfiles/11111111-1111-4111-8111-111111111111", {
  "method": "DELETE",
  "headers": {
    "X-Api-Key": process.env.FERRETLY_API_KEY,
    "Accept": "application/json"
  }
});
if (!response.ok) throw new Error("HTTP " + response.status);
console.log(await response.json());

import os
import requests

response = requests.request(
    "DELETE",
    "https://api.ferretly.com/api/PreferenceProfiles/11111111-1111-4111-8111-111111111111",
    headers={"X-Api-Key":os.environ["FERRETLY_API_KEY"],"Accept":"application/json"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://api.ferretly.com/api/PreferenceProfiles/11111111-1111-4111-8111-111111111111");
request.Headers.Add("X-Api-Key", Environment.GetEnvironmentVariable("FERRETLY_API_KEY"));
request.Headers.Accept.ParseAdd("application/json");
using var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Parameters

Name	In	Required	Type	Description
`id`	path	Yes	string (uuid)

Responses

200

Success

text/plain: OrganizationPreferencesProfile
application/json: OrganizationPreferencesProfile
text/json: OrganizationPreferencesProfile

400

The specified profile is the organization-wide default profile, which cannot be deleted.

401

The subscriber or organization identifier is missing from the request credentials.

403

The specified profile does not belong to the authenticated client’s organization.

404

No preference profile was found with the specified ID.

Response example

Illustrative, shortened HTTP 200 response. Optional fields can be absent or null.

{
  "id": "11111111-1111-4111-8111-111111111111",
  "profile_name": "Integration example",
  "isOrganizationDefaultProfile": false
}

Response properties

Property	Type	Description
`id`	string (uuid)	The unique identifier for this profile
`profile_name`	string	Nullable.
`organizationId`	string (uuid)	The organization to which this profile belongs
`organizationName`	string	The name of the organization Nullable.
`isOrganizationDefaultProfile`	boolean	Whether or not this profile is the organization default Read-only response field.
`subscriberId`	string (uuid)	If not null, this is a private profile Nullable.
`isPrivateProfile`	boolean	Read-only response field.
`isActive`	boolean	Support soft deletes of profiles
`risk_categories`	array of OrganizationRiskCategory	Nullable.
`key_words`	KeyWords
`general_settings`	GeneralSettings
`disabledPlatforms`	array of string	A list of social media platforms this profile has turned off. This list is exclusionary: if it is not empty, then handles on those platforms are not scraped and profiles found there are not attached automatically. If the list is empty, every platform applies. Nullable.
`lastEdited`	string (date-time)
`lastEditedBy`	string (uuid)	The ID of the Subscriber who last edited this profile. Null when the profile was last edited via the external API. Nullable.
`lastEditedByName`	string	The display name of the person or system that last edited this profile. Populated at write time. For human edits this is “{FirstName} {LastName}”; for external API edits this is the API client’s Owner name. Nullable.

risk_categories properties

Property	Type	Description
`id`	integer (int32)
`name`	string	Nullable.
`active`	boolean
`sort_order`	integer (int32)
`risk_type`	RiskType

key_words properties

Property	Type	Description
`is_active`	boolean
`key_words`	array of Keyword	Nullable.

general_settings properties

Property	Type	Description
`email_me`	boolean	Indicates whether to send background check status change emails to the user specified in NotificationEmailAddress
`notificationEmailAddress`	string	Nullable.
`email_subject_owner_on_completion`	boolean	When true, causes emails to be sent only upon mark redressed for organizations with Analyst Assistance, or upon run complete w/o Analyst Assistance.
`is_flagged`	boolean
`is_negative`	boolean
`is_positive`	boolean
`hide_logos`	boolean
`includeHelpPagesOnBackgroundReport`	boolean
`includeHyperlinksInReports`	boolean
`include_web_news_posts`	boolean	If true, a news/web search will be performed for the subject, and results will be added as new posts
`minimum_web_post_confidence_level`	string	String representation of MinimumWebPostConfidenceLevel, because of inconsistency in the way enums are serialized in the API Nullable.
`include_fcra`	boolean	Boolean to indicate whether FCRA warnings and disclaimers are shown, and to control number of years of posts to fetch
`isFCRAYearsOverriden`	boolean	When set to true, allows for AlternativeNumberOfYearsForPosts to specify number of years of posts to fetch
`alternativeNumberOfYearsForPosts`	integer (int32)	If IsFCRAYearsOverriden is true, number of years of posts to retrieve Nullable.
`anonymizeProfilePictureInReports`	boolean
`includePostInsightsInReports`	boolean
`basicInsightsIsOnePage`	boolean
`report_background_color`	string	Background color for the report. Nullable.
`hideSentimentOnReports`	boolean	If true then don’t display sentiment icon on posts pages in reports
`useAlternateDisclaimerText`	boolean	A boolean to indicate whether the organization’s “Alternate Disclaimer Text” should be used in the report
`showZeroScoreWhenNoHandles`	boolean	“Show Score as 0 when no handles”
`excludeHandleBiosOnCoverPage`	boolean	“Exclude Handle Bio’s on cover page”
`excludeScoreOnPostsInsights`	boolean	“Exclude score on post insights”
`isPrinterFriendlyReport`	boolean	Boolean to indicate that the report style should be “printer friendly”
`reportAnalyticsSections`	ReportAnalyticsSections
`includeAbstract`	boolean
`excludeFlaggedPostSummary`	boolean
`postTypesToAnalyze`	array of string	A list of post types that will be analyzed in the report. This list is exclusionary: if it is not empty, then only the post types in this list will be analyzed. If the list is empty, all post types will be analyzed. Nullable.
`showBehaviorIconsInReports`	boolean	Gets or sets a value indicating whether to show behavior icons on reports.
`redactNudeImagesInReports`	boolean	Gets or sets a value indicating whether to redact nude images in reports.
`group_posts_by`	string	String representation of GroupPostsBy, because of inconsistency in the way enums are serialized in the API Nullable.
`report_language_iso_code`	string	Gets or sets a value indicating report language ISO code Nullable.
`includePostTagsInReports`	boolean	Boolean to indicate whether to include each post’s Tags in reports
`hideSubjectProvidedPropertiesInReports`	boolean	Boolean to indicate whether to hide section with subject provided properties in reports.
`disableAutomaticAgenticSearch`	boolean	If true, prevents automatic agentic AI profile search from being initiated when a subject is assigned to an analyst or when a background check is initiated.